COPYRIGHT TEXT:
---------------

This file is part of the FreeRTOS port. Permission is hereby granted, free of
charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the
following conditions: The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://www.FreeRTOS.org http://aws.amazon.com/freertos 1 tab 4 spaces!

FILES:
ThirdParty/bsp/freertos10_xilinx/data/freertos10_xilinx.mld
ThirdParty/bsp/freertos10_xilinx/data/freertos10_xilinx.mss
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

This file is part of the FreeRTOS port. Permission is hereby granted, free of
charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the
following conditions: The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://www.FreeRTOS.org http://aws.amazon.com/freertos 1 tab 4 spaces! Return
latest "ACTIVE" standalone BSP version

FILES:
ThirdParty/bsp/freertos10_xilinx/data/freertos10_xilinx.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

AUTHORS:
Amazon.com, Inc. or its affiliates. All Rights Reserved., Amazon.com, Inc. or
its affiliates. All Rights Reserved. All Rights Reserved., Xilinx, Inc. All
rights reserved., –  Xilinx, Inc. All rights reserved.

DATES:
2018, 2018-2019, 2019

NOTICE: MIT
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions: The above copyright notice and this
permission notice shall be included in all copies or substantial portions of the
Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

FILES:
ThirdParty/bsp/freertos10_xilinx/examples/freertos_buffer.c
ThirdParty/bsp/freertos10_xilinx/examples/freertos_static_allocation.c
ThirdParty/bsp/freertos10_xilinx/examples/freertos_task_stats.c
ThirdParty/bsp/freertos10_xilinx/src/Source/croutine.c
ThirdParty/bsp/freertos10_xilinx/src/Source/event_groups.c
ThirdParty/bsp/freertos10_xilinx/src/Source/include/FreeRTOS.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/StackMacros.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/croutine.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/deprecated_definitions.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/event_groups.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/list.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/message_buffer.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/mpu_prototypes.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/mpu_wrappers.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/portable.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/projdefs.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/queue.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/semphr.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/stack_macros.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/stream_buffer.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/task.h
ThirdParty/bsp/freertos10_xilinx/src/Source/include/timers.h
ThirdParty/bsp/freertos10_xilinx/src/Source/list.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CA53/port.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CA53/portZynqUltrascale.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CA53/portmacro.h
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CA9/port.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CA9/portZynq7000.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CA9/portmacro.h
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CR5/port.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CR5/portZynqUltrascale.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/ARM_CR5/portmacro.h
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/MicroBlazeV9/port.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/MicroBlazeV9/port_exceptions.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/MicroBlazeV9/portmacro.h
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/GCC/MicroBlazeV9/portmicroblaze.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/MemMang/heap_1.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/MemMang/heap_2.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/MemMang/heap_3.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/MemMang/heap_4.c
ThirdParty/bsp/freertos10_xilinx/src/Source/portable/MemMang/heap_5.c
ThirdParty/bsp/freertos10_xilinx/src/Source/queue.c
ThirdParty/bsp/freertos10_xilinx/src/Source/stream_buffer.c
ThirdParty/bsp/freertos10_xilinx/src/Source/tasks.c
ThirdParty/bsp/freertos10_xilinx/src/Source/timers.c
XilinxProcessorIPLib/drivers/v_hdmirx1/data/v_hdmirx1.mdd
XilinxProcessorIPLib/drivers/v_hdmirx1/data/v_hdmirx1.tcl
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1.c
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1.h
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1_frl.c
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1_frl.h
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1_g.c
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1_hw.h
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1_intr.c
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1_selftest.c
XilinxProcessorIPLib/drivers/v_hdmirx1/src/xv_hdmirx1_sinit.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/data/v_hdmirxss1.mdd
XilinxProcessorIPLib/drivers/v_hdmirxss1/data/v_hdmirxss1.tcl
XilinxProcessorIPLib/drivers/v_hdmirxss1/data/v_hdmirxss1_header.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/aes.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/hmac.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/sha2.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/si5324drv.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/si5324drv.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/ti_lmk03318.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/ti_lmk03318.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/video_fmc.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/video_fmc.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/xhdcp22_common.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/platforms/platform.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/platforms/platform.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_edid.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_edid.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_rx.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_rx.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_tx.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_tx.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_menu.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/PassThrough/xhdmi_menu.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/audiogen_drv.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/audiogen_drv.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/onsemi_nb7nq621m.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/onsemi_nb7nq621m.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/si5324drv.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/si5324drv.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/si5344drv.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/si5344drv.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/ti_lmk03318.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/ti_lmk03318.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/video_fmc.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/video_fmc.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/xhdmi_hdcp_keys.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/xhdmi_hdcp_keys.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/xhdmi_hdcp_keys_table.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/xhdmi_intr.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/xhdmi_intr.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_coreinit.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_coreinit.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_frl.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_frl.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_g.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_hdcp.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_log.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/src/xv_hdmirxss1_sinit.c
XilinxProcessorIPLib/drivers/v_hdmitx1/data/v_hdmitx1.mdd
XilinxProcessorIPLib/drivers/v_hdmitx1/data/v_hdmitx1.tcl
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1.c
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1.h
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1_frl.c
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1_frl.h
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1_g.c
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1_hw.h
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1_intr.c
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1_selftest.c
XilinxProcessorIPLib/drivers/v_hdmitx1/src/xv_hdmitx1_sinit.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/data/v_hdmitxss1.mdd
XilinxProcessorIPLib/drivers/v_hdmitxss1/data/v_hdmitxss1.tcl
XilinxProcessorIPLib/drivers/v_hdmitxss1/data/v_hdmitxss1_header.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/aes.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/hmac.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/sha2.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/si5324drv.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/si5324drv.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/ti_lmk03318.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/ti_lmk03318.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/video_fmc.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/video_fmc.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/xhdcp22_common.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/platforms/platform.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/platforms/platform.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_edid.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_edid.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_rx.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_rx.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_tx.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_exdes_sm_tx.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_menu.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/PassThrough/xhdmi_menu.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/audiogen_drv.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/audiogen_drv.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/onsemi_nb7nq621m.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/onsemi_nb7nq621m.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/si5324drv.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/si5324drv.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/si5344drv.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/si5344drv.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/ti_lmk03318.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/ti_lmk03318.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/video_fmc.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/video_fmc.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/xhdmi_hdcp_keys.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/xhdmi_hdcp_keys.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/xhdmi_hdcp_keys_table.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/xhdmi_intr.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/xhdmi_intr.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_coreinit.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_coreinit.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_frl.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_frl.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_g.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_hdcp.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_log.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/src/xv_hdmitxss1_sinit.c
lib/sw_services/xilskey/examples/xilskey_puf_regeneration.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. If you wish to use our Amazon
FreeRTOS name, please do so in a fair use way that does not cause confusion. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://www.FreeRTOS.org http://aws.amazon.com/freertos 1 tab 4 spaces! / @file
FreeRTOSSTMTrace.h Contains FreeRTOS trace macros to write trace data to STM
address space on ZU+. STM generates STPI packets, which are consumed by SDK to
generate trace <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sdm 07/15/16 Initial version </pre>

FILES:
ThirdParty/bsp/freertos10_xilinx/src/FreeRTOSSTMTrace.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

This file is part of the port for FreeRTOS made by Xilinx to allow FreeRTOS to
operate with Xilinx Zynq devices. Permission is hereby granted, free of charge,
to any person obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. If you wish to use our Amazon
FreeRTOS name, please do so in a fair use way that does not cause confusion. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://www.FreeRTOS.org http://aws.amazon.com/freertos 1 tab 4 spaces! Processor
architecture microblaze

FILES:
ThirdParty/bsp/freertos10_xilinx/src/Makefile_microblaze
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

This file is part of the port for FreeRTOS made by Xilinx to allow FreeRTOS to
operate with Xilinx Zynq devices. Permission is hereby granted, free of charge,
to any person obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. If you wish to use our Amazon
FreeRTOS name, please do so in a fair use way that does not cause confusion. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://www.FreeRTOS.org http://aws.amazon.com/freertos 1 tab 4 spaces! Processor
architecture ps7_cortexa9

FILES:
ThirdParty/bsp/freertos10_xilinx/src/Makefile_ps7_cortexa9
ThirdParty/bsp/freertos10_xilinx/src/Makefile_psu_cortexr5
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

This file is part of the port for FreeRTOS made by Xilinx to allow FreeRTOS to
operate with Xilinx Zynq devices. Permission is hereby granted, free of charge,
to any person obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. If you wish to use our Amazon
FreeRTOS name, please do so in a fair use way that does not cause confusion. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://www.FreeRTOS.org http://aws.amazon.com/freertos 1 tab 4 spaces! Processor
architecture psu_cortexa53

FILES:
ThirdParty/bsp/freertos10_xilinx/src/Makefile_psu_cortexa53
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 srt 07/16/16 Initial Release 1.00 srm 02/21/18
Updated freertos to 10.0 version

FILES:
ThirdParty/sw_services/libmetal/data/libmetal.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 srt 05/16/16 Initial Release libmetal_drc

FILES:
ThirdParty/sw_services/libmetal/data/libmetal.tcl
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2015 - 2017, Xilinx Inc. and Contributors. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause / @file io.h @brief I/O access primitives
for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/io.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, ST Microelectronics. All rights reserved. SPDX-License-
Identifier: BSD-3-Clause / @file iar/compiler.h @brief IAR specific primitives
for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/compiler/iar/compiler.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2017, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file cpu.h @brief CPU specific primitives /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/processor/ceva/cpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file cpu.h @brief CPU specific primitives /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/processor/csky/cpu.h
ThirdParty/sw_services/libmetal/src/libmetal/lib/processor/riscv/cpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file freertos/cache.h @brief FreeRTOS cache
operation primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2016 - 2017, Xilinx Inc. and Contributors. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause / @file freertos/irq.c @brief FreeRTOS
libmetal irq definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/irq.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Linaro nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file freertos/log.h @brief
FreeRTOS libmetal log handler definition. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/log.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file freertos/sleep.h @brief FreeRTOS sleep
primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/sleep.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file generic/template/sys.c @brief machine
specific system primitives implementation. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/template/sys.c
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/template/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file freertos/template/sys.h @brief freertos
template system primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/template/sys.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2016 - 2017, Xilinx Inc. and Contributors. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause / @file generic/xlnx_common/irq.c @brief
generic libmetal Xilinx irq controller definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/xlnx_common/irq.c
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/xlnx_common/irq.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file freertos/zynq7/sys.c @brief machine
specific system primitives implementation. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/zynq7/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2016 - 2019, Xilinx Inc. and Contributors. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause / @file freertos/zynqmp_r5/sys.c @brief
machine specific system primitives implementation. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/freertos/zynqmp_r5/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file generic/cache.h @brief generic cache
operation primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2016 - 2017, Xilinx Inc. and Contributors. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause / @file generic/irq.c @brief generic
libmetal irq definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/irq.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Linaro nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file generic/log.h @brief Generic
libmetal log handler definition. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/log.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file generic/sleep.h @brief Generic sleep
primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/sleep.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file generic/template/sys.h @brief generic
template system primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/template/sys.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file generic/zynq7/sys.c @brief machine
specific system primitives implementation. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/zynq7/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2016 - 2019, Xilinx Inc. and Contributors. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause / @file generic/zynqmp_r5/sys.c @brief
machine specific system primitives implementation. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/generic/zynqmp_r5/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file linux/cache.h @brief Linux cache
operation primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/linux/cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Google]

COPYRIGHT TEXT:
---------------

SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note /
drivers/staging/android/uapi/ion.h Copyright (C) 2011 Google, Inc. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/linux/ion.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Linaro nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file linux/log.h @brief Linux
libmetal log handler definition. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/linux/log.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Linaro Limited. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file linux/sleep.h @brief linux sleep
primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/linux/sleep.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL]

COPYRIGHT TEXT:
---------------

SPDX-License-Identifier: GPL-2.0 / The header for UIO driver Author: Hyun Woo
Kwon <hyun.kwon@xilinx.com> /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/linux/uio.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/alloc.h @brief nuttx libmetal
memory allocattion definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/alloc.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file assert.h @brief NuttX assertion
support. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/assert.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/cache.h @brief NuttX cache
operation primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/condition.c @brief NuttX libmetal
condition variable handling. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/condition.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/condition.h @brief NuttX
condition variable primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/condition.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/device.c @brief NuttX libmetal
device definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/device.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/init.c @brief NuttX libmetal
initialization. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/init.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/io.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/io.h @brief NuttX specific io
definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/io.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/irq.c @brief NuttX libmetal irq
definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/irq.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/irq.h @brief NuttX libmetal irq
definitions. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/irq.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/log.h @brief NuttX libmetal log
handler definition. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/log.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/mutex.h @brief NuttX mutex
primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/mutex.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/sleep.h @brief NuttX sleep
primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/sleep.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/sys.h @brief NuttX system
primitives for libmetal. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/sys.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2018, Pinecone Inc. and Contributors. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / @file nuttx/time.c @brief NuttX libmetal time
handling. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/lib/system/nuttx/time.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Xilinx nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / Template file used to ensure that
each <metal/...> header can be included without independently without prior
inclusion of dependencies. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/test/metal-header-template.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Xilinx nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/test/metal-test.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/freertos/alloc.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/freertos/atomic.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/freertos/main.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/freertos/mutex.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/freertos/sleep.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/freertos/threads.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/alloc.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/atomic.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/main.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/mutex.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/alloc.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/atomic.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/condition.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/main.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/mutex.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/spinlock.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/threads.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/linux/zynq/device.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/zephyr/alloc.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/zephyr/atomic.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/zephyr/main.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/zephyr/mutex.c
ThirdParty/sw_services/libmetal/src/libmetal/test/version.c
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/libmetal_amp_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/shmem_atomic_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/shmem_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/sys_init.c
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/sys_init.h
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/libmetal_amp_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/shmem_atomic_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/shmem_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/sys_init.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/sys_init.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Xilinx nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file metal-test.h @brief Top level
include internal to libmetal tests. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/test/metal-test.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of the <ORGANIZATION> nor
the names of its contributors may be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/microblaze_generic/helper.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/microblaze_generic/platform.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/microblaze_generic/platform.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. Neither the name of the <ORGANIZATION> nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/zynq7/helper.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/zynqmp_a53/helper.c
ThirdParty/sw_services/libmetal/src/libmetal/test/system/generic/zynqmp_r5/helper.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2017, Linaro Limited. and Contributors. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
Neither the name of Linaro nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. / @file system/zephyr/metal-test-internal.h @brief Zephyr
include internal to libmetal tests. /

FILES:
ThirdParty/sw_services/libmetal/src/libmetal/test/system/zephyr/metal-test-internal.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

sys_arch.c provide sys_arch functionality as required for lwIP most of this
functionality is obtained from xilkernel this file acts as a wrapper around the
xilkernel functions / All rights reserved. Permission is hereby granted, free of
charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the
following conditions: The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FILES:
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/sys_arch.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FILES:
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/netif/xadapter.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/netif/xaxiemacif.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/netif/xemacliteif.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/netif/xemacpsif.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/netif/xlltemacif.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/netif/xpqueue.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/netif/xtopology.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xadapter.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xaxiemacif_dma.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xaxiemacif_fifo.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xaxiemacif_hw.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xaxiemacif_hw.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xemacpsif_dma.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xemacpsif_hw.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xemacpsif_hw.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xpqueue.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/sys_arch_raw.c
XilinxProcessorIPLib/drivers/clockps/data/clockps.mdd
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keygen_config.h
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_keyfile.h
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keys.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keygen_config.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_keyfile.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001, 2002 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/lwipopts.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/lwipopts.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/lwipopts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2003 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> / All rights reserved. Xilinx, Inc. XILINX IS PROVIDING THIS
DESIGN, CODE, OR INFORMATION "AS IS" AS A COURTESY TO YOU. BY PROVIDING THIS
DESIGN, CODE, OR INFORMATION AS ONE POSSIBLE IMPLEMENTATION OF THIS FEATURE,
APPLICATION OR STANDARD, XILINX IS MAKING NO REPRESENTATION THAT THIS
IMPLEMENTATION IS FREE FROM ANY CLAIMS OF INFRINGEMENT, AND YOU ARE RESPONSIBLE
FOR OBTAINING ANY RIGHTS YOU MAY REQUIRE FOR YOUR IMPLEMENTATION. XILINX
EXPRESSLY DISCLAIMS ANY WARRANTY WHATSOEVER WITH RESPECT TO THE ADEQUACY OF THE
IMPLEMENTATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OR REPRESENTATIONS
THAT THIS IMPLEMENTATION IS FREE FROM CLAIMS OF INFRINGEMENT, IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. /

FILES:
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/arch/cc.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/arch/cpu.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/arch/perf.h
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/include/arch/sys_arch.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> / All rights reserved. Xilinx, Inc. XILINX IS PROVIDING THIS
DESIGN, CODE, OR INFORMATION "AS IS" AS A COURTESY TO YOU. BY PROVIDING THIS
DESIGN, CODE, OR INFORMATION AS ONE POSSIBLE IMPLEMENTATION OF THIS FEATURE,
APPLICATION OR STANDARD, XILINX IS MAKING NO REPRESENTATION THAT THIS
IMPLEMENTATION IS FREE FROM ANY CLAIMS OF INFRINGEMENT, AND YOU ARE RESPONSIBLE
FOR OBTAINING ANY RIGHTS YOU MAY REQUIRE FOR YOUR IMPLEMENTATION. XILINX
EXPRESSLY DISCLAIMS ANY WARRANTY WHATSOEVER WITH RESPECT TO THE ADEQUACY OF THE
IMPLEMENTATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OR REPRESENTATIONS
THAT THIS IMPLEMENTATION IS FREE FROM CLAIMS OF INFRINGEMENT, IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. /

FILES:
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xaxiemacif.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xemacliteif.c
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xemacpsif.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2007-2008, Advanced Micro Devices, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: Redistributions of
source code must retain the above copyright notice, this list of conditions and
the following disclaimer. Redistributions in binary form must reproduce the
above copyright notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution. Neither
the name of Advanced Micro Devices, Inc. nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. / Some portions copyright (c) 2010-2017 Xilinx, Inc. All rights
reserved. Xilinx, Inc. XILINX IS PROVIDING THIS DESIGN, CODE, OR INFORMATION "AS
IS" AS A COURTESY TO YOU. BY PROVIDING THIS DESIGN, CODE, OR INFORMATION AS ONE
POSSIBLE IMPLEMENTATION OF THIS FEATURE, APPLICATION OR STANDARD, XILINX IS
MAKING NO REPRESENTATION THAT THIS IMPLEMENTATION IS FREE FROM ANY CLAIMS OF
INFRINGEMENT, AND YOU ARE RESPONSIBLE FOR OBTAINING ANY RIGHTS YOU MAY REQUIRE
FOR YOUR IMPLEMENTATION. XILINX EXPRESSLY DISCLAIMS ANY WARRANTY WHATSOEVER WITH
RESPECT TO THE ADEQUACY OF THE IMPLEMENTATION, INCLUDING BUT NOT LIMITED TO ANY
WARRANTIES OR REPRESENTATIONS THAT THIS IMPLEMENTATION IS FREE FROM CLAIMS OF
INFRINGEMENT, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. /

FILES:
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xaxiemacif_physpeed.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. This file
xemacpsif_physpeed.c implements functionalities to: - Detect the available PHYs
connected to a MAC - Negotiate speed - Configure speed - Configure the SLCR
registers for the negotiated speed In a typical use case, users of the APIs
implemented in this file need to do the following. - Call the API detect_phy. It
probes for the available PHYs connected to a MAC. The MACs can be Emac0
(XPAR_XEMACPS_0_BASEADDR, 0xE000B000) or Emac1 (XPAR_XEMACPS_0_BASEADDR,
0xE000C000). It populates an array to notify about the detected PHYs. The array
phymapemac0 is used for Emac0 and phymapemac1 is for Emac1. - The users need to
parse the corresponding arrays, phymapemac0 or phymapemac1 to know the available
PHYs for a MAC. The users then need to call phy_setup to setup the PHYs for
proper speed setting. The API phy_setup should be called with the PHY address
for which the speed needs to be negotiated or configured. In a specific use
case, if 2 PHYs are connected to Emac0 with addresses of 7 and 11, then users
get these address details from phymapemac0 (after calling detect_phy) and then
call phy_setup twice, with ab address of 7 and 11. - Points to note: The MAC can
operate at only one speed. If a MAC is connected to multiple PHYs, then all PHYs
must negotiate and configured for the same speed. - This file implements static
functions to set proper SLCR clocks. As stated above, all PHYs connected to a
PHY must operate at same speed and the SLCR clock will be setup accordingly.
This file implements the following PHY types. - The standard RGMII. - It
provides support for GMII to RGMII converter Xilinx IP. This Xilinx IP sits on
the MDIO bus with a predefined PHY address. This IP exposes register that needs
to be programmed with the negotiated speed. For example, in a typical design,
the Emac0 or Emac1 exposes GMII interface. The user can then use the Xilinx IP
that converts GMII to RGMII. The external PHY (most typically Marvell 88E1116R)
negotiates for speed with the remote PHY. The implementation in this file then
programs the Xilinx IP with this negotiated speed. The Xilinx IP has a
predefined IP address exposed through xparameters.h - The SGMII and 1000 BaseX
PHY interfaces. If the PHY interface is SGMII or 1000 BaseX a separate
"get_IEEE_phy_speed" is used which is different from standard RGMII
"get_IEEE_phy_speed". The 1000 BaseX always operates at 1000 Mbps. The SGMII
interface can negotiate speed accordingly. For SGMII or 1000 BaseX interfaces,
the detect_phy should not be called. The phy addresses for these interfaces are
fixed at the design time. Point to note: A MAC can not be connected to PHYs
where there is a mix between SGMII or 1000 Basex or GMII/MII/RGMII. In a typical
multiple PHY designs, it is expected that the PHYs connected will be RGMII or
GMII. The users can choose not to negotiate speed from lwip settings GUI. If
they opt to choose a particular PHY speed, then the PHY will hard code the speed
to operate only at the corresponding speed. It will not advertise any other
speeds. It is users responsibility to ensure that the remote PHY supports the
speed programmed through the lwip gui. The following combination of MDIO/PHY are
supported: - Multiple PHYs connected to the MDIO bus of a MAC. If Emac0 MDIO is
connected to single/multiple PHYs, it is supported. Similarly Emac1 MDIO
connected to single/multiple PHYs is supported. - A design where both the
interfaces are present and are connected to their own MDIO bus is supported. The
following MDIO/PHY setup is not supported: - A design has both the MACs present.
MDIO bus is available only for one MAC (Emac0 or Emac1). This MDIO bus has
multiple PHYs available for both the MACs. The negotiated speed for PHYs sitting
on the MDIO bus of one MAC will not be see for the other MAC and hence the
speed/SLCR settings of the other MAC cannot be programmed. Hence this kind of
design will not work for this implementation.

FILES:
ThirdParty/sw_services/lwip141/src/contrib/ports/xilinx/netif/xemacpsif_physpeed.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Sequential API External module / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> / This is the part of the API that is
linked with the application /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/api_lib.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Sequential API Internal module / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/api_msg.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/api_msg.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/api_msg.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Error Management module / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/err.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/err.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/err.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Network buffer management / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/netbuf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file API functions for name resolving / Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/netdb.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file Network Interface Sequential API module / Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/netifapi.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Sockets BSD-Like API module / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> Improved by Marc Boucher
<marc@mbsi.ca> and David Haas <dhaas@alum.rpi.edu> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/sockets.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/sockets.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Sequential API Main thread module / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/api/tcpip.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/tcpip.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/tcpip.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Common functions used throughout the stack. / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/def.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Dynamic Host Configuration Protocol client / Copyright (c) 2001-2004 Leon
Woestenberg <leon.woestenberg@gmx.net> Copyright (c) 2001-2004 Axon Digital
Design B.V., The Netherlands. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is a
contribution to the lwIP TCP/IP stack. The Swedish Institute of Computer Science
and Adam Dunkels are specifically granted permission to redistribute this source
code. Author: Leon Woestenberg <leon.woestenberg@gmx.net> This is a DHCP client
for the lwIP TCP/IP stack. It aims to conform with RFC 2131 and RFC 2132. TODO:
- Support for interfaces other than Ethernet (SLIP, PPP, ...) Please coordinate
changes and requests with Leon Woestenberg <leon.woestenberg@gmx.net>
Integration with your code: In lwip/dhcp.h define DHCP_COARSE_TIMER_SECS
(recommended 60 which is a minute) define DHCP_FINE_TIMER_MSECS (recommended 500
which equals TCP coarse timer) Then have your application call dhcp_coarse_tmr()
and dhcp_fine_tmr() on the defined intervals. dhcp_start(struct netif netif);
starts a DHCP client instance which configures the interface by obtaining an IP
address lease and maintaining it. Use dhcp_release(netif) to end the lease and
use dhcp_stop(netif) to remove the DHCP client. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/dhcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DNS - host name to IP address resolver. / This file implements a DNS host
name to IP address resolver. Port to lwIP from uIP by Jim Pettinato April 2007
uIP version Copyright (c) 2002-2003, Adam Dunkels. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
DNS.C The lwIP DNS resolver functions are used to lookup a host name and map it
to a numerical IP address. It maintains a list of resolved hostnames that can be
queried with the dns_lookup() function. New hostnames can be resolved using the
dns_query() function. The lwIP version of the resolver also adds a non-blocking
version of gethostbyname() that will work with a raw API application. This
function checks for an IP address string first and converts it if it is valid.
gethostbyname() then does a dns_lookup() to see if the name is already in the
table. If so, the IP is returned. If not, a query is issued and the function
returns with a ERR_INPROGRESS status. The app using the dns client must then go
into a waiting state. Once a hostname has been resolved (or found to be non-
existent), the resolver code calls a specified callback function (which must be
implemented by the module that uses the resolver). / RFC 1035 - Domain names -
implementation and specification RFC 2181 - Clarifications to the DNS
Specification
----------------------------------------------------------------------------/
@todo: define good default values (rfc compliance) / @todo: improve answer
parsing, more checkings... / @todo: check RFC1035 - 7.3. Processing responses /
Includes
----------------------------------------------------------------------------/

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/dns.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Modules initialization / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/init.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/init.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/init.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file Dynamic memory manager This is a lightweight replacement for the standard
C library malloc(). If you want to use the standard C library malloc() instead,
define MEM_LIBC_MALLOC to 1 in your lwipopts.h To let mem_malloc() use pools
(prevents fragmentation and is much faster than a heap but might waste some
memory), define MEM_USE_POOLS to 1, define MEM_USE_CUSTOM_POOLS to 1 and create
a file "lwippools.h" that includes a list of pools like this (more pools can be
added between _START and _END): Define three pools with sizes 256, 512, and 1512
bytes LWIP_MALLOC_MEMPOOL_START LWIP_MALLOC_MEMPOOL(20, 256)
LWIP_MALLOC_MEMPOOL(10, 512) LWIP_MALLOC_MEMPOOL(5, 1512)
LWIP_MALLOC_MEMPOOL_END / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/mem.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Dynamic pool memory manager lwIP has dedicated pools for many structures
(netconn, protocol control blocks, packet buffers, ...). All these pools are
managed here. / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/memp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP network interface abstraction / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/netif.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Packet buffer management Packets are built from the pbuf data structure.
It supports dynamic memory allocation for packet contents or can reference
externally managed packet contents both in RAM and ROM. Quick allocation for
incoming packets is provided through pools with fixed sized pbufs. A packet may
span over multiple pbufs, chained as a singly linked list. This is called a
"pbuf chain". Multiple packets may be queued, also using this singly linked
list. This is called a "packet queue". So, a packet queue consists of one or
more pbuf chains, each of which consist of one or more pbufs. CURRENTLY, PACKET
QUEUES ARE NOT SUPPORTED!!! Use helper structs to queue multiple packets. The
differences between a pbuf chain and a packet queue are very precise but subtle.
The last pbuf of a packet has a ->tot_len field that equals the ->len field. It
can be found by traversing the list. If the last pbuf of a packet has a ->next
field other than NULL, more packets are on the queue. Therefore, looping through
a pbuf of a single packet, has an loop end condition (tot_len p->len), NOT (next
NULL). / Copyright (c) 2001-2004 Swedish Institute of Computer Science. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/pbuf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Implementation of raw protocol PCBs for low-level handling of different
types of protocols besides (or overriding) those already available in lwIP. /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/raw.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Statistics module / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/stats.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/stats.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/stats.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP Operating System abstraction / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Transmission Control Protocol for IP This file contains common functions
for the TCP implementation, such as functinos for manipulating the data
structures and the TCP timer functions. TCP functions related to input and
output is found in tcp_in.c and tcp_out.c respectively. / Copyright (c)
2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/tcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Transmission Control Protocol, incoming traffic The input processing
functions of the TCP layer. These functions are generally called in the order
(ip_input() ->) tcp_input() -> tcp_process() -> tcp_receive() (-> application).
/ Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/tcp_in.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/tcp_in.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/tcp_in.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Transmission Control Protocol, outgoing traffic The output functions of
TCP. / Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/tcp_out.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/tcp_out.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Stack-internal timers implementation. This file includes timer callbacks
for stack-internal timers as well as functions to set up or stop timers and
check for expired timers. / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/timers.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/timeouts.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/timeouts.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file User Datagram Protocol module / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> / udp.c The code for the User
Datagram Protocol UDP & UDPLite (RFC 3828). / @todo Check the use of '(struct
udp_pcb).chksum_len_rx'! /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/udp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file AutoIP Automatic LinkLocal IP Configuration / Copyright (c) 2007 Dominik
Spies <kontakt@dspies.de> All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dominik Spies
<kontakt@dspies.de> This is a AutoIP implementation for the lwIP TCP/IP stack.
It aims to conform with RFC 3927. Please coordinate changes and requests with
Dominik Spies <kontakt@dspies.de> / USAGE: define LWIP_AUTOIP 1 in your
lwipopts.h If you don't use tcpip.c (so, don't call, you don't call tcpip_init):
- First, call autoip_init(). - call autoip_tmr() all AUTOIP_TMR_INTERVAL msces,
that should be defined in autoip.h. I recommend a value of 100. The value must
divide 1000 with a remainder almost 0. Possible values are 1000, 500, 333, 250,
200, 166, 142, 125, 111, 100 .... Without DHCP: - Call autoip_start() after
netif_add(). With DHCP: - define LWIP_DHCP_AUTOIP_COOP 1 in your lwipopts.h. -
Configure your DHCP Client. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/autoip.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file ICMP - Internet Control Message Protocol / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> / Some ICMP
messages should be passed to the transport protocols. This is not implemented. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/icmp.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/icmp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/icmp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IGMP - Internet Group Management Protocol / Copyright (c) 2002 CITEL
Technologies Ltd. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. Neither the name of CITEL
Technologies Ltd nor the names of its contributors may be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL CITEL TECHNOLOGIES OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is a
contribution to the lwIP TCP/IP stack. The Swedish Institute of Computer Science
and Adam Dunkels are specifically granted permission to redistribute this source
code. Note 1) Although the rfc requires V1 AND V2 capability we will only
support v2 since now V1 is very old (August 1989) V1 can be added if required a
debug print and statistic have been implemented to show this up. Note 2) A query
for a specific group address (as opposed to ALLHOSTS) has now been implemented
as I am unsure if it is required a debug print and statistic have been
implemented to show this up. Note 3) The router alert rfc 2113 is implemented in
outgoing packets but not checked rigorously incoming Steve Reynolds RFC 988 -
Host extensions for IP multicasting - V0 RFC 1054 - Host extensions for IP
multicasting RFC 1112 - Host extensions for IP multicasting - V1 RFC 2236 -
Internet Group Management Protocol, Version 2 - V2 <- this code is based on this
RFC (it's the "de facto" standard) RFC 3376 - Internet Group Management
Protocol, Version 3 - V3 RFC 4604 - Using Internet Group Management Protocol
Version 3... - V3+ RFC 2113 - IP Router Alert Option
----------------------------------------------------------------------------/
Includes
----------------------------------------------------------------------------/

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/igmp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Functions common to all TCP/IPv4 modules, such as the byte order
functions. / Copyright (c) 2001-2004 Swedish Institute of Computer Science. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/inet.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Incluse internet checksum functions. / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/inet_chksum.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file This is the IPv4 layer implementation for incoming and outgoing IP
traffic. @see ip_frag.c / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/ip.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/ip4.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/ip4.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file This is the IPv4 address tools implementation. / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/ip_addr.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/ip4_addr.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/ip4_addr.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file This is the IPv4 packet segmentation and reassembly implementation. /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Jani Monoses
<jani@iv.ro> Simon Goldschmidt original reassembly code by Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv4/ip_frag.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/ip4_frag.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/ip4_frag.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> / Some ICMP messages should be passed to the transport protocols.
This is not implemented. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv6/icmp6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Functions common to all TCP/IPv6 modules, such as the Internet checksum
and the byte order functions. / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv6/inet6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> / ip.c This is the code for the IP layer for IPv6. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv6/ip6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/ipv6/ip6_addr.c
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/icmp.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/inet.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/inet_chksum.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/ip.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/ip_addr.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv6/lwip/icmp.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv6/lwip/inet.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv6/lwip/ip.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv6/lwip/ip_addr.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/api.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/api_msg.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/arch.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/debug.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/def.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/err.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/init.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/mem.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/memp.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/netbuf.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/netif.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/pbuf.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/raw.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/sockets.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/stats.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/sys.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/tcp.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/tcp_impl.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/tcpip.h
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/udp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Abstract Syntax Notation One (ISO 8824, 8825) decoding @todo not optimised
(yet), favor correctness over speed, favor speed over size / Copyright (c) 2006
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/snmp/asn1_dec.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Abstract Syntax Notation One (ISO 8824, 8825) encoding @todo not optimised
(yet), favor correctness over speed, favor speed over size / Copyright (c) 2006
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/snmp/asn1_enc.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) objects and functions. @note the
object identifiers for this MIB-2 and private MIB tree must be kept in sorted
ascending order. This to ensure correct getnext operation. / Copyright (c) 2006
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/snmp/mib2.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file MIB tree access/construction functions. / Copyright (c) 2006 Axon Digital
Design B.V., The Netherlands. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/snmp/mib_structs.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP input message processing (RFC1157). / Copyright (c) 2006 Axon Digital
Design B.V., The Netherlands. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/snmp/msg_in.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP output message processing (RFC1157). Output responses and traps are
build in two passes: Pass 0: iterate over the output message backwards to
determine encoding lengths Pass 1: the actual forward encoding of internal form
into ASN1 The single-pass encoding method described by Comer & Stevens requires
extra buffer space and copying for reversal of the packet. The buffer
requirement can be prohibitively large for big payloads (> 484) therefore we use
the two encoding passes. / Copyright (c) 2006 Axon Digital Design B.V., The
Netherlands. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/core/snmp/msg_out.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file AutoIP Automatic LinkLocal IP Configuration / Copyright (c) 2007 Dominik
Spies <kontakt@dspies.de> All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dominik Spies
<kontakt@dspies.de> This is a AutoIP implementation for the lwIP TCP/IP stack.
It aims to conform with RFC 3927. Please coordinate changes and requests with
Dominik Spies <kontakt@dspies.de> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/autoip.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2002 CITEL Technologies Ltd. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. Neither
the name of CITEL Technologies Ltd nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND
CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CITEL TECHNOLOGIES OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is a contribution to the lwIP TCP/IP stack. The
Swedish Institute of Computer Science and Adam Dunkels are specifically granted
permission to redistribute this source code.

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/igmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Jani Monoses
<jani@iv.ro> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/ipv4/lwip/ip_frag.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

lwip DNS resolver header file. Author: Jim Pettinato April 2007 ported from uIP
resolv.c Copyright (c) 2002-2003, Adam Dunkels. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/dns.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/netdb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/netifapi.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/ppp_opts.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/pppapi.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/ppp_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/pppapi.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP Options Configuration / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/opt.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. / This is the
interface to the platform specific serial IO module It needs to be implemented
by those platforms which need SLIP or PPP /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/sio.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/sio.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/sio.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001, 2002 Leon Woestenberg <leon.woestenberg@axon.tv> Copyright
(c) 2001, 2002 Axon Digital Design B.V., The Netherlands. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Leon Woestenberg
<leon.woestenberg@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/snmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Abstract Syntax Notation One (ISO 8824, 8825) codec. / Copyright (c) 2006
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/snmp_asn1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP Agent message handling structures. / Copyright (c) 2006 Axon Digital
Design B.V., The Netherlands. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/snmp_msg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Generic MIB tree structures. @todo namespace prefixes / Copyright (c) 2006
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/snmp_structs.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/lwip/timers.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2003 Swedish Institute of Computer Science. Copyright (c)
2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv> Copyright (c) 2003-2004
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/netif/etharp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

ppp_oe.h - PPP Over Ethernet implementation for lwIP. Copyright (c) 2006 by Marc
Boucher, Services Informatiques (MBSI) inc. The authors hereby grant permission
to use, copy, modify, distribute, and license this software and its
documentation for any purpose, provided that existing copyright notices are
retained in all copies and that this notice and the following disclaimer are
included verbatim in any distributions. No written agreement, license, or
royalty fee is required for any of the authorized uses. THIS SOFTWARE IS
PROVIDED BY THE CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. REVISION HISTORY 06-01-01 Marc Boucher <marc@mbsi.ca> Ported to
lwIP. based on NetBSD: if_pppoe.c,v 1.64 2006/01/31 23:50:15 martin Exp /
Copyright (c) 2002 The NetBSD Foundation, Inc. All rights reserved. This code is
derived from software contributed to The NetBSD Foundation by Martin Husemann
<martin@NetBSD.org>. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. All advertising materials mentioning features
or use of this software must display the following acknowledgement: This product
includes software developed by the NetBSD Foundation, Inc. and its contributors.
4. Neither the name of The NetBSD Foundation nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE NETBSD
FOUNDATION, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/netif/ppp_oe.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001, Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
Neither the name of the Institute nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/include/netif/slipif.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Address Resolution Protocol module for IP over Ethernet Functionally, ARP
is divided into two parts. The first maps an IP address to a physical address
when sending a packet, and the second part answers requests from other machines
for our physical address. This implementation complies with RFC 826 (Ethernet
ARP). It supports Gratuitious ARP from RFC3220 (IP Mobility Support for IPv4)
section 4.6 if an interface calls etharp_gratuitous(our_netif) upon address
change. / Copyright (c) 2001-2003 Swedish Institute of Computer Science.
Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv> Copyright
(c) 2003-2004 Axon Digital Design B.V., The Netherlands. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/netif/etharp.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/etharp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file Ethernet Interface Skeleton / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> / This file is a skeleton for
developing Ethernet network interface drivers for lwIP. Add code to the
low_level functions and do a search-and-replace for the word "ethernetif" to
replace it with something that better describes your network interface. /

FILES:
ThirdParty/sw_services/lwip141/src/lwip-1.4.1/src/netif/ethernetif.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ethernetif.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FILES:
ThirdParty/sw_services/lwip202/data/lwip202.mld
ThirdParty/sw_services/lwip202/data/lwip202.tcl
ThirdParty/sw_services/lwip211/data/lwip211.mld
ThirdParty/sw_services/lwip211/data/lwip211.tcl
XilinxProcessorIPLib/drivers/aiengine/data/aiengine.mdd
XilinxProcessorIPLib/drivers/aiengine/data/aiengine.tcl
XilinxProcessorIPLib/drivers/aiengine/src/Makefile
XilinxProcessorIPLib/drivers/audio_formatter/data/audio_formatter.mdd
XilinxProcessorIPLib/drivers/audio_formatter/src/xaudioformatter_g.c
XilinxProcessorIPLib/drivers/avbuf/data/avbuf.mdd
XilinxProcessorIPLib/drivers/axicdma/data/axicdma.mdd
XilinxProcessorIPLib/drivers/axicdma/data/axicdma.tcl
XilinxProcessorIPLib/drivers/axicdma/data/xaxicdma_sg_intr_header.h
XilinxProcessorIPLib/drivers/axicdma/data/xaxicdma_sg_poll_header.h
XilinxProcessorIPLib/drivers/axicdma/data/xaxicdma_simple_intr_header.h
XilinxProcessorIPLib/drivers/axicdma/data/xaxicdma_simple_poll_header.h
XilinxProcessorIPLib/drivers/axicdma/src/xdebug.h
XilinxProcessorIPLib/drivers/axidma/data/axidma.mdd
XilinxProcessorIPLib/drivers/axidma/data/axidma_header.h
XilinxProcessorIPLib/drivers/axidma/src/xdebug.h
XilinxProcessorIPLib/drivers/axiethernet/data/axiethernet_fifo_intr_header.h
XilinxProcessorIPLib/drivers/axiethernet/data/axiethernet_header.h
XilinxProcessorIPLib/drivers/axiethernet/data/axiethernet_intr_header.h
XilinxProcessorIPLib/drivers/axiethernet/data/axiethernet_mcdma_intr_header.h
XilinxProcessorIPLib/drivers/axiethernet/src/xaxiethernet_g.c
XilinxProcessorIPLib/drivers/axiethernet/src/xdebug.h
XilinxProcessorIPLib/drivers/axipmon/data/axipmon.mdd
XilinxProcessorIPLib/drivers/axis_switch/data/axis_switch.mdd
XilinxProcessorIPLib/drivers/axis_switch/data/axis_switch.tcl
XilinxProcessorIPLib/drivers/axivdma/data/axivdma.mdd
XilinxProcessorIPLib/drivers/axivdma/data/axivdma_header.h
XilinxProcessorIPLib/drivers/axivdma/src/xdebug.h
XilinxProcessorIPLib/drivers/bram/data/bram.mdd
XilinxProcessorIPLib/drivers/bram/data/bram_header.h
XilinxProcessorIPLib/drivers/bram/data/bram_intr_header.h
XilinxProcessorIPLib/drivers/can/data/can_header.h
XilinxProcessorIPLib/drivers/canfd/src/xcanfd_g.c
XilinxProcessorIPLib/drivers/canps/data/canps.mdd
XilinxProcessorIPLib/drivers/canps/data/canps_header.h
XilinxProcessorIPLib/drivers/ccm/data/ccm.mdd
XilinxProcessorIPLib/drivers/ccm/src/xccm_g.c
XilinxProcessorIPLib/drivers/cfa/data/cfa.mdd
XilinxProcessorIPLib/drivers/cfa/src/xcfa_g.c
XilinxProcessorIPLib/drivers/cframe/data/cframe.mdd
XilinxProcessorIPLib/drivers/cfupmc/data/cfupmc.mdd
XilinxProcessorIPLib/drivers/clk_wiz/data/clk_wiz_header.h
XilinxProcessorIPLib/drivers/clk_wiz/src/xclk_wiz_g.c
XilinxProcessorIPLib/drivers/common/data/common.mdd
XilinxProcessorIPLib/drivers/common/src/xdebug.h
XilinxProcessorIPLib/drivers/coresightps_dcc/data/coresightps_dcc.mdd
XilinxProcessorIPLib/drivers/cpu_cortexa53/data/cpu_cortexa53.mdd
XilinxProcessorIPLib/drivers/cpu_cortexa72/data/cpu_cortexa72.mdd
XilinxProcessorIPLib/drivers/cpu_cortexa9/data/cpu_cortexa9.mdd
XilinxProcessorIPLib/drivers/cpu_cortexr5/data/cpu_cortexr5.mdd
XilinxProcessorIPLib/drivers/cresample/data/cresample.mdd
XilinxProcessorIPLib/drivers/cresample/src/xcresample_g.c
XilinxProcessorIPLib/drivers/csi/data/csi.mdd
XilinxProcessorIPLib/drivers/csi/data/xcsi_header.h
XilinxProcessorIPLib/drivers/csi/src/xcsi_g.c
XilinxProcessorIPLib/drivers/csi2tx/data/csi2tx.mdd
XilinxProcessorIPLib/drivers/csi2tx/data/xcsi2tx_header.h
XilinxProcessorIPLib/drivers/csi2tx/src/xcsi2tx_g.c
XilinxProcessorIPLib/drivers/csi2txss/data/csi2txss.mdd
XilinxProcessorIPLib/drivers/csi2txss/data/xcsi2txss_header.h
XilinxProcessorIPLib/drivers/csi2txss/src/xcsi2txss_g.c
XilinxProcessorIPLib/drivers/csudma/data/csudma.mdd
XilinxProcessorIPLib/drivers/csudma/data/csudma_header.h
XilinxProcessorIPLib/drivers/csudma/src/xcsudma_g.c
XilinxProcessorIPLib/drivers/deinterlacer/data/deinterlacer.mdd
XilinxProcessorIPLib/drivers/devcfg/data/devcfg.mdd
XilinxProcessorIPLib/drivers/devcfg/data/devcfg_header.h
XilinxProcessorIPLib/drivers/dmaps/data/dmaps.mdd
XilinxProcessorIPLib/drivers/dmaps/data/dmaps_header.h
XilinxProcessorIPLib/drivers/dp12/data/dp12.mdd
XilinxProcessorIPLib/drivers/dp14/data/dp14.mdd
XilinxProcessorIPLib/drivers/dp14rxss/data/dp14rxss.mdd
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/clk_set.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/xdptxss_zcu102_tx.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keygen_config.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_keyfile.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keys.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keygen_config.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_keyfile.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keys.c
XilinxProcessorIPLib/drivers/dp14txss/data/dp14txss.mdd
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/clk_set.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/xdptxss_zcu102_tx.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keygen_config.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_keyfile.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keys.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keygen_config.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_keyfile.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keys.c
XilinxProcessorIPLib/drivers/dpdma/data/dpdma.mdd
XilinxProcessorIPLib/drivers/dphy/data/dphy.mdd
XilinxProcessorIPLib/drivers/dphy/data/xdphy_header.h
XilinxProcessorIPLib/drivers/dphy/src/xdphy_g.c
XilinxProcessorIPLib/drivers/dppsu/data/dppsu.mdd
XilinxProcessorIPLib/drivers/dsi/data/dsi.mdd
XilinxProcessorIPLib/drivers/dsi/data/xdsi_header.h
XilinxProcessorIPLib/drivers/dsi/src/xdsi_g.c
XilinxProcessorIPLib/drivers/dsitxss/data/dsitxss_header.h
XilinxProcessorIPLib/drivers/dsitxss/src/xdsitxss_g.c
XilinxProcessorIPLib/drivers/dual_splitter/data/dual_splitter.mdd
XilinxProcessorIPLib/drivers/dual_splitter/data/dual_splitter.tcl
XilinxProcessorIPLib/drivers/dual_splitter/src/xdualsplitter_g.c
XilinxProcessorIPLib/drivers/emaclite/data/emaclite_header.h
XilinxProcessorIPLib/drivers/emaclite/data/emaclite_intr_header.h
XilinxProcessorIPLib/drivers/emacps/data/emacps.mdd
XilinxProcessorIPLib/drivers/emacps/data/emacps_header.h
XilinxProcessorIPLib/drivers/enhance/data/enhance.mdd
XilinxProcessorIPLib/drivers/enhance/src/xenhance_g.c
XilinxProcessorIPLib/drivers/gamma/data/gamma.mdd
XilinxProcessorIPLib/drivers/gamma/data/gamma.tcl
XilinxProcessorIPLib/drivers/generic/data/generic.mdd
XilinxProcessorIPLib/drivers/gpio/data/gpio.tcl
XilinxProcessorIPLib/drivers/gpio/data/gpio_header.h
XilinxProcessorIPLib/drivers/gpio/data/gpio_intr_header.h
XilinxProcessorIPLib/drivers/gpiops/data/gpiops.mdd
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_g.c
XilinxProcessorIPLib/drivers/hdcp22_cipher/data/hdcp22_cipher.mdd
XilinxProcessorIPLib/drivers/hdcp22_cipher/data/hdcp22_cipher.tcl
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/data/hdcp22_cipher_dp.mdd
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/data/hdcp22_cipher_dp.tcl
XilinxProcessorIPLib/drivers/hdcp22_common/data/hdcp22_common.mdd
XilinxProcessorIPLib/drivers/hdcp22_mmult/data/hdcp22_mmult.mdd
XilinxProcessorIPLib/drivers/hdcp22_mmult/data/hdcp22_mmult.tcl
XilinxProcessorIPLib/drivers/hdcp22_mmult/src/xhdcp22_mmult_g.c
XilinxProcessorIPLib/drivers/hdcp22_rng/data/hdcp22_rng.mdd
XilinxProcessorIPLib/drivers/hdcp22_rng/data/hdcp22_rng.tcl
XilinxProcessorIPLib/drivers/hdcp22_rng/src/xhdcp22_rng_g.c
XilinxProcessorIPLib/drivers/hdcp22_rx/data/hdcp22_rx.mdd
XilinxProcessorIPLib/drivers/hdcp22_rx/data/hdcp22_rx.tcl
XilinxProcessorIPLib/drivers/hdcp22_rx/src/xhdcp22_rx_g.c
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/data/hdcp22_rx_dp.mdd
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/data/hdcp22_rx_dp.tcl
XilinxProcessorIPLib/drivers/hdcp22_tx/data/hdcp22_tx.mdd
XilinxProcessorIPLib/drivers/hdcp22_tx/data/hdcp22_tx.tcl
XilinxProcessorIPLib/drivers/hdcp22_tx/src/xhdcp22_tx_g.c
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/data/hdcp22_tx_dp.mdd
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/data/hdcp22_tx_dp.tcl
XilinxProcessorIPLib/drivers/hwicap/data/hwicap_header.h
XilinxProcessorIPLib/drivers/i2srx/data/i2srx.mdd
XilinxProcessorIPLib/drivers/i2srx/data/i2srx.tcl
XilinxProcessorIPLib/drivers/iic/data/iic_header.h
XilinxProcessorIPLib/drivers/iicps/data/iicps.mdd
XilinxProcessorIPLib/drivers/iicps/data/iicps_header.h
XilinxProcessorIPLib/drivers/intc/data/intc_header.h
XilinxProcessorIPLib/drivers/iomodule/data/iomodule.mdd
XilinxProcessorIPLib/drivers/iomodule/data/iomodule_header.h
XilinxProcessorIPLib/drivers/iomodule/data/iomodule_intr_header.h
XilinxProcessorIPLib/drivers/ipipsu/data/ipipsu.mdd
XilinxProcessorIPLib/drivers/ipipsu/src/xipipsu_g.c
XilinxProcessorIPLib/drivers/llfifo/src/xdebug.h
XilinxProcessorIPLib/drivers/mbox/data/mbox_header.h
XilinxProcessorIPLib/drivers/mcdma/data/mcdma.mdd
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma_g.c
XilinxProcessorIPLib/drivers/mig/data/mig.mdd
XilinxProcessorIPLib/drivers/mig_7series/data/mig_7series.mdd
XilinxProcessorIPLib/drivers/mipicsiss/data/mipicsiss.mdd
XilinxProcessorIPLib/drivers/mipicsiss/data/xcsiss_header.h
XilinxProcessorIPLib/drivers/mipicsiss/src/xcsiss_g.c
XilinxProcessorIPLib/drivers/mpegtsmux/data/mpegtsmux.mdd
XilinxProcessorIPLib/drivers/mpegtsmux/data/mpegtsmux.tcl
XilinxProcessorIPLib/drivers/mpegtsmux/src/xmpegtsmux.h
XilinxProcessorIPLib/drivers/mpegtsmux/src/xmpegtsmux_g.c
XilinxProcessorIPLib/drivers/mpegtsmux/src/xmpegtsmux_linux.c
XilinxProcessorIPLib/drivers/mpegtsmux/src/xmpegtsmux_sinit.c
XilinxProcessorIPLib/drivers/mutex/data/mutex_header.h
XilinxProcessorIPLib/drivers/nandps/data/nandps.mdd
XilinxProcessorIPLib/drivers/nandpsu/data/nandpsu.mdd
XilinxProcessorIPLib/drivers/nandpsu/src/Makefile
XilinxProcessorIPLib/drivers/osd/src/xosd_g.c
XilinxProcessorIPLib/drivers/ospipsv/data/ospipsv.mdd
XilinxProcessorIPLib/drivers/pmonpsv/data/pmonpsv.mdd
XilinxProcessorIPLib/drivers/prc/data/prc.mdd
XilinxProcessorIPLib/drivers/prc/src/xprc_g.c
XilinxProcessorIPLib/drivers/prd/data/prd.mdd
XilinxProcessorIPLib/drivers/prd/src/xprd_g.c
XilinxProcessorIPLib/drivers/qspips/data/qspips.mdd
XilinxProcessorIPLib/drivers/qspips/data/qspips_header.h
XilinxProcessorIPLib/drivers/qspipsu/data/qspipsu.mdd
XilinxProcessorIPLib/drivers/resetps/data/resetps.mdd
XilinxProcessorIPLib/drivers/rgb2ycrcb/data/rgb2ycrcb.mdd
XilinxProcessorIPLib/drivers/rgb2ycrcb/src/xrgb2ycrcb_g.c
XilinxProcessorIPLib/drivers/rtcpsu/data/rtcpsu.mdd
XilinxProcessorIPLib/drivers/scugic/data/scugic.mdd
XilinxProcessorIPLib/drivers/scugic/data/scugic_header.h
XilinxProcessorIPLib/drivers/scutimer/data/scutimer.mdd
XilinxProcessorIPLib/drivers/scutimer/data/scutimer_header.h
XilinxProcessorIPLib/drivers/scuwdt/data/scuwdt.mdd
XilinxProcessorIPLib/drivers/scuwdt/data/scuwdt_header.h
XilinxProcessorIPLib/drivers/sd_fec/data/sd_fec.mdd
XilinxProcessorIPLib/drivers/sd_fec/data/sd_fec.tcl
XilinxProcessorIPLib/drivers/sd_fec/src/Makefile
XilinxProcessorIPLib/drivers/sd_fec/src/xsdfec_sinit.c
XilinxProcessorIPLib/drivers/sdiaud/data/sdiaud.mdd
XilinxProcessorIPLib/drivers/sdiaud/data/xsdiaud_header.h
XilinxProcessorIPLib/drivers/sdps/data/sdps.mdd
XilinxProcessorIPLib/drivers/spdif/data/spdif.mdd
XilinxProcessorIPLib/drivers/spdif/data/spdif.tcl
XilinxProcessorIPLib/drivers/spi/data/spi_header.h
XilinxProcessorIPLib/drivers/spi/data/spi_intr_header.h
XilinxProcessorIPLib/drivers/spips/data/spips.mdd
XilinxProcessorIPLib/drivers/spips/data/spips_header.h
XilinxProcessorIPLib/drivers/sysmon/data/sysmon_header.h
XilinxProcessorIPLib/drivers/sysmon/data/sysmon_intr_header.h
XilinxProcessorIPLib/drivers/sysmonpsu/data/sysmonpsu.mdd
XilinxProcessorIPLib/drivers/sysmonpsu/data/sysmonpsu_header.h
XilinxProcessorIPLib/drivers/sysmonpsv/data/sysmonpsv.mdd
XilinxProcessorIPLib/drivers/tft/data/tft.mdd
XilinxProcessorIPLib/drivers/tmr_inject/data/tmr_inject_header.h
XilinxProcessorIPLib/drivers/tmr_manager/data/tmr_manager_header.h
XilinxProcessorIPLib/drivers/tmr_manager/data/tmr_manager_intr_header.h
XilinxProcessorIPLib/drivers/tmrctr/data/tmrctr_header.h
XilinxProcessorIPLib/drivers/tmrctr/data/tmrctr_intr_header.h
XilinxProcessorIPLib/drivers/tpg/data/tpg.mdd
XilinxProcessorIPLib/drivers/tpg/src/xtpg_g.c
XilinxProcessorIPLib/drivers/trafgen/data/trafgen.mdd
XilinxProcessorIPLib/drivers/ttcps/data/ttcps.mdd
XilinxProcessorIPLib/drivers/ttcps/data/ttcps_header.h
XilinxProcessorIPLib/drivers/uartlite/data/uartlite_header.h
XilinxProcessorIPLib/drivers/uartlite/data/uartlite_intr_header.h
XilinxProcessorIPLib/drivers/uartns550/data/uartns550_header.h
XilinxProcessorIPLib/drivers/uartns550/data/uartns550_intr_header.h
XilinxProcessorIPLib/drivers/uartps/data/uartps.mdd
XilinxProcessorIPLib/drivers/uartps/data/uartps_header.h
XilinxProcessorIPLib/drivers/uartps/data/uartps_intr_header.h
XilinxProcessorIPLib/drivers/uartpsv/data/uartpsv.mdd
XilinxProcessorIPLib/drivers/uartpsv/data/uartpsv_header.h
XilinxProcessorIPLib/drivers/uartpsv/data/uartpsv_intr_header.h
XilinxProcessorIPLib/drivers/usbps/data/usbps.mdd
XilinxProcessorIPLib/drivers/usbpsu/data/usbpsu.mdd
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_g.c
XilinxProcessorIPLib/drivers/v_axi4s_remap/data/v_axi4s_remap.mdd
XilinxProcessorIPLib/drivers/v_axi4s_remap/data/v_axi4s_remap.tcl
XilinxProcessorIPLib/drivers/v_axi4s_remap/src/xv_axi4s_remap_g.c
XilinxProcessorIPLib/drivers/v_csc/data/v_csc.mdd
XilinxProcessorIPLib/drivers/v_csc/src/xv_csc_g.c
XilinxProcessorIPLib/drivers/v_deinterlacer/data/v_deinterlacer.mdd
XilinxProcessorIPLib/drivers/v_deinterlacer/data/v_deinterlacer.tcl
XilinxProcessorIPLib/drivers/v_deinterlacer/src/xv_deinterlacer_g.c
XilinxProcessorIPLib/drivers/v_demosaic/data/v_demosaic.mdd
XilinxProcessorIPLib/drivers/v_demosaic/data/v_demosaic.tcl
XilinxProcessorIPLib/drivers/v_demosaic/examples/src/main.c
XilinxProcessorIPLib/drivers/v_demosaic/src/xv_demosaic_g.c
XilinxProcessorIPLib/drivers/v_frmbuf_rd/data/v_frmbuf_rd.mdd
XilinxProcessorIPLib/drivers/v_frmbuf_rd/data/v_frmbuf_rd.tcl
XilinxProcessorIPLib/drivers/v_frmbuf_rd/examples/src/platform.c
XilinxProcessorIPLib/drivers/v_frmbuf_rd/examples/src/platform.h
XilinxProcessorIPLib/drivers/v_frmbuf_wr/data/v_frmbuf_wr.mdd
XilinxProcessorIPLib/drivers/v_frmbuf_wr/data/v_frmbuf_wr.tcl
XilinxProcessorIPLib/drivers/v_frmbuf_wr/examples/src/platform.c
XilinxProcessorIPLib/drivers/v_frmbuf_wr/examples/src/platform.h
XilinxProcessorIPLib/drivers/v_gamma_lut/data/v_gamma_lut.mdd
XilinxProcessorIPLib/drivers/v_gamma_lut/data/v_gamma_lut.tcl
XilinxProcessorIPLib/drivers/v_gamma_lut/src/xv_gamma_lut_g.c
XilinxProcessorIPLib/drivers/v_hcresampler/data/v_hcresampler.mdd
XilinxProcessorIPLib/drivers/v_hcresampler/data/v_hcresampler.tcl
XilinxProcessorIPLib/drivers/v_hcresampler/src/xv_hcresampler_g.c
XilinxProcessorIPLib/drivers/v_hdmi_common/data/v_hdmi_common.mdd
XilinxProcessorIPLib/drivers/v_hdmiphy1/data/v_hdmiphy1.mdd
XilinxProcessorIPLib/drivers/v_hdmirx/data/v_hdmirx.mdd
XilinxProcessorIPLib/drivers/v_hdmirx/data/v_hdmirx.tcl
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx_g.c
XilinxProcessorIPLib/drivers/v_hdmirxss/data/v_hdmirxss_header.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/platforms/platform.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/platforms/platform.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/dp159.h
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss_g.c
XilinxProcessorIPLib/drivers/v_hdmitx/data/v_hdmitx.mdd
XilinxProcessorIPLib/drivers/v_hdmitx/data/v_hdmitx.tcl
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx_g.c
XilinxProcessorIPLib/drivers/v_hdmitxss/data/v_hdmitxss_header.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/platforms/platform.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/platforms/platform.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/dp159.h
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss_g.c
XilinxProcessorIPLib/drivers/v_hscaler/data/v_hscaler.mdd
XilinxProcessorIPLib/drivers/v_hscaler/src/xv_hscaler_g.c
XilinxProcessorIPLib/drivers/v_letterbox/data/v_letterbox.mdd
XilinxProcessorIPLib/drivers/v_letterbox/data/v_letterbox.tcl
XilinxProcessorIPLib/drivers/v_letterbox/src/xv_letterbox_g.c
XilinxProcessorIPLib/drivers/v_mix/data/v_mix.mdd
XilinxProcessorIPLib/drivers/v_mix/data/v_mix.tcl
XilinxProcessorIPLib/drivers/v_mix/examples/src/platform.c
XilinxProcessorIPLib/drivers/v_mix/examples/src/platform.h
XilinxProcessorIPLib/drivers/v_mix/src/xv_mix_g.c
XilinxProcessorIPLib/drivers/v_scenechange/examples/src/platform.c
XilinxProcessorIPLib/drivers/v_scenechange/examples/src/platform.h
XilinxProcessorIPLib/drivers/v_sdirx/data/v_sdirx.tcl
XilinxProcessorIPLib/drivers/v_sdirx/src/xv_sdirx_g.c
XilinxProcessorIPLib/drivers/v_sdirxss/data/xv_sdirxss_header.h
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss_g.c
XilinxProcessorIPLib/drivers/v_sditx/data/v_sditx.tcl
XilinxProcessorIPLib/drivers/v_sditx/src/xv_sditx_g.c
XilinxProcessorIPLib/drivers/v_sditxss/data/xv_sditxss_header.h
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss_g.c
XilinxProcessorIPLib/drivers/v_tpg/data/v_tpg.mdd
XilinxProcessorIPLib/drivers/v_tpg/data/v_tpg.tcl
XilinxProcessorIPLib/drivers/v_tpg/src/xv_tpg_g.c
XilinxProcessorIPLib/drivers/v_vcresampler/data/v_vcresampler.mdd
XilinxProcessorIPLib/drivers/v_vcresampler/data/v_vcresampler.tcl
XilinxProcessorIPLib/drivers/v_vcresampler/src/xv_vcresampler_g.c
XilinxProcessorIPLib/drivers/v_voip_decap/data/v_voip_decap.mdd
XilinxProcessorIPLib/drivers/v_voip_decap/data/v_voip_decap.tcl
XilinxProcessorIPLib/drivers/v_voip_depacketizer56/data/v_voip_depacketizer56.mdd
XilinxProcessorIPLib/drivers/v_voip_depacketizer56/data/v_voip_depacketizer56.tcl
XilinxProcessorIPLib/drivers/v_voip_fec_rx/data/v_voip_fec_rx.mdd
XilinxProcessorIPLib/drivers/v_voip_fec_rx/data/v_voip_fec_rx.tcl
XilinxProcessorIPLib/drivers/v_voip_fec_tx/data/v_voip_fec_tx.mdd
XilinxProcessorIPLib/drivers/v_voip_fec_tx/data/v_voip_fec_tx.tcl
XilinxProcessorIPLib/drivers/v_voip_framer/data/v_voip_framer.mdd
XilinxProcessorIPLib/drivers/v_voip_framer/data/v_voip_framer.tcl
XilinxProcessorIPLib/drivers/v_voip_packetizer56/data/v_voip_packetizer56.mdd
XilinxProcessorIPLib/drivers/v_voip_packetizer56/data/v_voip_packetizer56.tcl
XilinxProcessorIPLib/drivers/v_vscaler/data/v_vscaler.mdd
XilinxProcessorIPLib/drivers/v_vscaler/data/v_vscaler.tcl
XilinxProcessorIPLib/drivers/v_vscaler/src/xv_vscaler_g.c
XilinxProcessorIPLib/drivers/video_common/data/video_common.mdd
XilinxProcessorIPLib/drivers/vphy/data/vphy.mdd
XilinxProcessorIPLib/drivers/vphy/src/xvphy_g.c
XilinxProcessorIPLib/drivers/vprocss/data/vprocss.mdd
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_g.c
XilinxProcessorIPLib/drivers/vtc/src/xvtc_g.c
XilinxProcessorIPLib/drivers/wdtps/data/wdtps.mdd
XilinxProcessorIPLib/drivers/wdtps/data/wdtps_header.h
XilinxProcessorIPLib/drivers/xadcps/data/xadcps.mdd
XilinxProcessorIPLib/drivers/xxvethernet/src/xxxvethernet_g.c
XilinxProcessorIPLib/drivers/ycrcb2rgb/data/ycrcb2rgb.mdd
XilinxProcessorIPLib/drivers/zdma/data/zdma.mdd
XilinxProcessorIPLib/drivers/zdma/data/zdma_header.h
XilinxProcessorIPLib/drivers/zdma/src/xzdma_g.c
lib/bsp/standalone/data/standalone.mld
lib/bsp/standalone/src/arm/ARMv8/32bit/gcc/Makefile
lib/bsp/standalone/src/arm/ARMv8/64bit/armclang/Makefile
lib/bsp/standalone/src/arm/ARMv8/64bit/gcc/Makefile
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xfpd_slave_xmpu.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xfpd_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xfpd_slcr_secure.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xlpd_iou_secure_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xlpd_iou_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xlpd_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xlpd_slcr_secure.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xlpd_xppu.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xocm_xmpu.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xpmc_iou_secure_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xpmc_iou_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xpmc_xmpu.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/Versal/xpmc_xppu.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xddr_xmpu0_cfg.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xddr_xmpu1_cfg.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xddr_xmpu2_cfg.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xddr_xmpu3_cfg.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xddr_xmpu4_cfg.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xddr_xmpu5_cfg.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xfpd_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xfpd_slcr_secure.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xfpd_xmpu_cfg.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xfpd_xmpu_sink.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xiou_secure_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xiou_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xlpd_slcr.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xlpd_slcr_secure.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xlpd_xppu.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xlpd_xppu_sink.h
lib/bsp/standalone/src/arm/ARMv8/includes_ps/platform/ZynqMP/xocm_xmpu_cfg.h
lib/bsp/standalone/src/arm/common/gcc/_exit.c
lib/bsp/standalone/src/arm/common/gcc/_open.c
lib/bsp/standalone/src/arm/common/gcc/_sbrk.c
lib/bsp/standalone/src/arm/common/gcc/abort.c
lib/bsp/standalone/src/arm/common/gcc/close.c
lib/bsp/standalone/src/arm/common/gcc/fcntl.c
lib/bsp/standalone/src/arm/common/gcc/fstat.c
lib/bsp/standalone/src/arm/common/gcc/getpid.c
lib/bsp/standalone/src/arm/common/gcc/isatty.c
lib/bsp/standalone/src/arm/common/gcc/kill.c
lib/bsp/standalone/src/arm/common/gcc/lseek.c
lib/bsp/standalone/src/arm/common/gcc/open.c
lib/bsp/standalone/src/arm/common/gcc/sbrk.c
lib/bsp/standalone/src/arm/common/gcc/unlink.c
lib/bsp/standalone/src/arm/common/iccarm/abort.c
lib/bsp/standalone/src/arm/common/iccarm/close.c
lib/bsp/standalone/src/arm/common/iccarm/exit.c
lib/bsp/standalone/src/arm/cortexa9/armcc/Makefile
lib/bsp/standalone/src/arm/cortexa9/gcc/Makefile
lib/bsp/standalone/src/arm/cortexa9/iccarm/Makefile
lib/bsp/standalone/src/arm/cortexr5/gcc/Makefile
lib/bsp/standalone/src/arm/cortexr5/iccarm/Makefile
lib/bsp/standalone/src/microblaze/_exit.c
lib/bsp/standalone/src/profile/_profile_clean.c
lib/bsp/standalone/src/profile/mblaze_nt_types.h
lib/bsp/standalone/src/profile/profile.h
lib/bsp/standalone/src/profile/profile_cg.c
lib/bsp/standalone/src/profile/profile_config.h
lib/bsp/standalone/src/profile/profile_hist.c
lib/sw_apps/ddr_self_refresh/data/ddr_self_refresh.mss
lib/sw_apps/ddr_self_refresh/data/ddr_self_refresh.tcl
lib/sw_apps/freertos_hello_world/data/freertos_hello_world.tcl
lib/sw_apps/libmetal_echo_demo/data/libmetal_echo_demo.mss
lib/sw_apps/libmetal_echo_demo/data/libmetal_echo_demo.tcl
lib/sw_apps/mba_fs_boot/data/mba_fs_boot.mss
lib/sw_apps/mba_fs_boot/data/mba_fs_boot.tcl
lib/sw_apps/mba_fs_boot/src/fs-xspi.c
lib/sw_apps/mba_fs_boot/src/winbond-spi-flash.c
lib/sw_apps/openamp_echo_test/data/openamp_echo_test.mss
lib/sw_apps/openamp_echo_test/data/openamp_echo_test.tcl
lib/sw_apps/openamp_matrix_multiply/data/openamp_matrix_multiply.mss
lib/sw_apps/openamp_matrix_multiply/data/openamp_matrix_multiply.tcl
lib/sw_apps/openamp_rpc_demo/data/openamp_rpc_demo.mss
lib/sw_apps/openamp_rpc_demo/data/openamp_rpc_demo.tcl
lib/sw_apps/versal_plm/data/versal_plm.mss
lib/sw_apps/versal_plm/data/versal_plm.tcl
lib/sw_apps/versal_pmcfw/data/versal_pmcfw.mss
lib/sw_apps/versal_pmcfw/data/versal_pmcfw.tcl
lib/sw_apps/versal_psmfw/data/versal_psmfw.mss
lib/sw_apps/versal_psmfw/data/versal_psmfw.tcl
lib/sw_apps/xilkernel_thread_demo/src/platform.c
lib/sw_apps/xilkernel_thread_demo/src/platform.h
lib/sw_apps/zynq_fsbl/src/Makefile
lib/sw_apps/zynqmp_fsbl/data/zynqmp_fsbl.mss
lib/sw_apps/zynqmp_fsbl/data/zynqmp_fsbl.tcl
lib/sw_apps/zynqmp_fsbl/misc/Makefile_standalone_armclang
lib/sw_apps/zynqmp_fsbl/misc/pm_cfg_obj.c
lib/sw_apps/zynqmp_fsbl/misc/xipipsu_g.c
lib/sw_apps/zynqmp_fsbl/src/Makefile
lib/sw_apps/zynqmp_pmufw/data/zynqmp_pmufw.mss
lib/sw_apps/zynqmp_pmufw/data/zynqmp_pmufw.tcl
lib/sw_apps/zynqmp_pmufw/misc/xcsudma_g.c
lib/sw_apps/zynqmp_pmufw/misc/xipipsu_g.c
lib/sw_apps/zynqmp_pmufw/misc/xuartps_g.c
lib/sw_apps/zynqmp_pmufw/src/afi.h
lib/sw_apps/zynqmp_pmufw/src/apu.h
lib/sw_apps/zynqmp_pmufw/src/crf_apb.h
lib/sw_apps/zynqmp_pmufw/src/crl_apb.h
lib/sw_apps/zynqmp_pmufw/src/csu.h
lib/sw_apps/zynqmp_pmufw/src/csudma.h
lib/sw_apps/zynqmp_pmufw/src/gpio.h
lib/sw_apps/zynqmp_pmufw/src/ipi.h
lib/sw_apps/zynqmp_pmufw/src/lpd_slcr.h
lib/sw_apps/zynqmp_pmufw/src/pmu_global.h
lib/sw_apps/zynqmp_pmufw/src/pmu_iomodule.h
lib/sw_apps/zynqmp_pmufw/src/pmu_lmb_bram.h
lib/sw_apps/zynqmp_pmufw/src/pmu_local.h
lib/sw_apps/zynqmp_pmufw/src/rpu.h
lib/sw_apps/zynqmp_pmufw/src/rsa.h
lib/sw_apps/zynqmp_pmufw/src/rsa_core.h
lib/sw_apps/zynqmp_pmufw/src/rtc.h
lib/sw_apps/zynqmp_pmufw/src/uart0.h
lib/sw_apps/zynqmp_pmufw/src/uart1.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_aib.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_aib.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_config.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_core.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_core.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_crc.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_crc.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_default.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_error_manager.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_error_manager.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_events.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_events.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_interrupts.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_interrupts.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_ipi_manager.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_ipi_manager.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_main.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_dap.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_dap.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_em.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_em.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_legacy.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_legacy.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_pm.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_pm.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_rtc.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_rtc.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_sched.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_sched.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_stl.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_stl.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_ultra96.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_ultra96.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_wdt.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_mod_wdt.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_module.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_platform.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_platform.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_resets.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_resets.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_restart.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_restart.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_scheduler.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_scheduler.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_user_startup.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_user_startup.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_util.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_util.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_version.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_xpu.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_xpu.h
lib/sw_services/xilffs/src/Makefile
lib/sw_services/xilflash/src/Makefile
lib/sw_services/xilfpga/src/Makefile
lib/sw_services/xilisf/src/Makefile
lib/sw_services/xillibpm/src/client/xpm_client_api.c
lib/sw_services/xillibpm/src/client/xpm_client_api.h
lib/sw_services/xillibpm/src/client/xpm_client_callbacks.c
lib/sw_services/xillibpm/src/client/xpm_client_callbacks.h
lib/sw_services/xillibpm/src/client/xpm_client_common.c
lib/sw_services/xillibpm/src/client/xpm_client_common.h
lib/sw_services/xillibpm/src/client/xpm_client_ipi.c
lib/sw_services/xillibpm/src/client/xpm_client_ipi.h
lib/sw_services/xillibpm/src/common/Makefile
lib/sw_services/xillibpm/src/common/xillibpm_defs.h
lib/sw_services/xillibpm/src/common/xillibpm_node.h
lib/sw_services/xillibpm/src/server/xillibpm_api.c
lib/sw_services/xillibpm/src/server/xillibpm_api.h
lib/sw_services/xillibpm/src/server/xpm_aie.c
lib/sw_services/xillibpm/src/server/xpm_aie.h
lib/sw_services/xillibpm/src/server/xpm_apucore.c
lib/sw_services/xillibpm/src/server/xpm_apucore.h
lib/sw_services/xillibpm/src/server/xpm_bisr.c
lib/sw_services/xillibpm/src/server/xpm_bisr.h
lib/sw_services/xillibpm/src/server/xpm_clock.c
lib/sw_services/xillibpm/src/server/xpm_clock.h
lib/sw_services/xillibpm/src/server/xpm_common.c
lib/sw_services/xillibpm/src/server/xpm_common.h
lib/sw_services/xillibpm/src/server/xpm_core.c
lib/sw_services/xillibpm/src/server/xpm_core.h
lib/sw_services/xillibpm/src/server/xpm_cpmdomain.c
lib/sw_services/xillibpm/src/server/xpm_cpmdomain.h
lib/sw_services/xillibpm/src/server/xpm_device.c
lib/sw_services/xillibpm/src/server/xpm_device.h
lib/sw_services/xillibpm/src/server/xpm_device_idle.c
lib/sw_services/xillibpm/src/server/xpm_device_idle.h
lib/sw_services/xillibpm/src/server/xpm_domain_iso.c
lib/sw_services/xillibpm/src/server/xpm_domain_iso.h
lib/sw_services/xillibpm/src/server/xpm_gic_proxy.c
lib/sw_services/xillibpm/src/server/xpm_gic_proxy.h
lib/sw_services/xillibpm/src/server/xpm_mem.c
lib/sw_services/xillibpm/src/server/xpm_mem.h
lib/sw_services/xillibpm/src/server/xpm_node.c
lib/sw_services/xillibpm/src/server/xpm_node.h
lib/sw_services/xillibpm/src/server/xpm_notifier.c
lib/sw_services/xillibpm/src/server/xpm_notifier.h
lib/sw_services/xillibpm/src/server/xpm_npdomain.c
lib/sw_services/xillibpm/src/server/xpm_npdomain.h
lib/sw_services/xillibpm/src/server/xpm_periph.c
lib/sw_services/xillibpm/src/server/xpm_periph.h
lib/sw_services/xillibpm/src/server/xpm_pin.c
lib/sw_services/xillibpm/src/server/xpm_pin.h
lib/sw_services/xillibpm/src/server/xpm_pinfunc.c
lib/sw_services/xillibpm/src/server/xpm_pinfunc.h
lib/sw_services/xillibpm/src/server/xpm_pldomain.c
lib/sw_services/xillibpm/src/server/xpm_pldomain.h
lib/sw_services/xillibpm/src/server/xpm_pll.c
lib/sw_services/xillibpm/src/server/xpm_pll.h
lib/sw_services/xillibpm/src/server/xpm_pmcdomain.c
lib/sw_services/xillibpm/src/server/xpm_pmcdomain.h
lib/sw_services/xillibpm/src/server/xpm_power.c
lib/sw_services/xillibpm/src/server/xpm_power.h
lib/sw_services/xillibpm/src/server/xpm_powerdomain.c
lib/sw_services/xillibpm/src/server/xpm_powerdomain.h
lib/sw_services/xillibpm/src/server/xpm_prot.c
lib/sw_services/xillibpm/src/server/xpm_prot.h
lib/sw_services/xillibpm/src/server/xpm_psfpdomain.c
lib/sw_services/xillibpm/src/server/xpm_psfpdomain.h
lib/sw_services/xillibpm/src/server/xpm_pslpdomain.c
lib/sw_services/xillibpm/src/server/xpm_pslpdomain.h
lib/sw_services/xillibpm/src/server/xpm_psm.c
lib/sw_services/xillibpm/src/server/xpm_psm.h
lib/sw_services/xillibpm/src/server/xpm_requirement.c
lib/sw_services/xillibpm/src/server/xpm_requirement.h
lib/sw_services/xillibpm/src/server/xpm_reset.c
lib/sw_services/xillibpm/src/server/xpm_reset.h
lib/sw_services/xillibpm/src/server/xpm_rpucore.c
lib/sw_services/xillibpm/src/server/xpm_rpucore.h
lib/sw_services/xillibpm/src/server/xpm_subsystem.c
lib/sw_services/xillibpm/src/server/xpm_subsystem.h
lib/sw_services/xilloader/src/Makefile
lib/sw_services/xilmailbox/src/Makefile
lib/sw_services/xilmfs/data/xilmfs.mld
lib/sw_services/xilmfs/data/xilmfs.tcl
lib/sw_services/xilmfs/src/Makefile
lib/sw_services/xilmfs/src/mfs_filesys.c
lib/sw_services/xilmfs/src/mfs_filesys_util.c
lib/sw_services/xilmfs/src/utils/test_mfs_filesys.c
lib/sw_services/xilmfs/src/utils/testmfs.c
lib/sw_services/xilmfs/src/utils/testmfsflashrom.c
lib/sw_services/xilmfs/src/utils/testmfsrom.c
lib/sw_services/xilmfs/src/xilmfs.h
lib/sw_services/xilpdi/src/Makefile
lib/sw_services/xilplmi/src/Makefile
lib/sw_services/xilpm/data/xilpm.mld
lib/sw_services/xilpm/data/xilpm.tcl
lib/sw_services/xilpm/examples/gic_setup.h
lib/sw_services/xilpm/src/apu/pm_apu.h
lib/sw_services/xilpm/src/common/pm_cfg_obj.h
lib/sw_services/xilpm/src/rpu/pm_rpu.h
lib/sw_services/xilrsa/src/Makefile
lib/sw_services/xilsecure/src/Makefile
lib/sw_services/xilskey/src/Makefile
lib/sw_services/xilskey/src/xilskey_jscmd.h
lib/sw_services/xilskey/src/xilskey_jslib.c
lib/sw_services/xilskey/src/xilskey_jtag.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_igmp_app.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_igmp_app.h
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_igmp_main.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftp_client.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftp_platform_fs.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftp_platform_fs.h
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftp_server.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftpclient_common.h
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftpclient_main.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftpserver_common.h
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_tftpserver_main.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_web_utils.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_webserver.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_webserver.h
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_ws_http_response.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_ws_main.c
ThirdParty/sw_services/lwip202/examples/freertos_lwip_example_ws_platform_fs.c
ThirdParty/sw_services/lwip202/examples/lwip_example_igmp_app.c
ThirdParty/sw_services/lwip202/examples/lwip_example_igmp_app.h
ThirdParty/sw_services/lwip202/examples/lwip_example_igmp_main.c
ThirdParty/sw_services/lwip202/examples/lwip_example_iic_phyreset.c
ThirdParty/sw_services/lwip202/examples/lwip_example_platform.c
ThirdParty/sw_services/lwip202/examples/lwip_example_platform.h
ThirdParty/sw_services/lwip202/examples/lwip_example_platform_config.h
ThirdParty/sw_services/lwip202/examples/lwip_example_tftp_client.c
ThirdParty/sw_services/lwip202/examples/lwip_example_tftp_platform_fs.c
ThirdParty/sw_services/lwip202/examples/lwip_example_tftp_platform_fs.h
ThirdParty/sw_services/lwip202/examples/lwip_example_tftp_server.c
ThirdParty/sw_services/lwip202/examples/lwip_example_tftpclient_common.h
ThirdParty/sw_services/lwip202/examples/lwip_example_tftpclient_main.c
ThirdParty/sw_services/lwip202/examples/lwip_example_tftpserver_common.h
ThirdParty/sw_services/lwip202/examples/lwip_example_tftpserver_main.c
ThirdParty/sw_services/lwip202/examples/lwip_example_web_utils.c
ThirdParty/sw_services/lwip202/examples/lwip_example_webserver.h
ThirdParty/sw_services/lwip202/examples/lwip_example_ws_http_response.c
ThirdParty/sw_services/lwip202/examples/lwip_example_ws_main.c
ThirdParty/sw_services/lwip202/examples/lwip_example_ws_platform_fs.c
ThirdParty/sw_services/lwip202/examples/lwip_example_ws_platform_fs.h
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_igmp_app.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_igmp_app.h
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_igmp_main.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftp_client.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftp_platform_fs.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftp_platform_fs.h
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftp_server.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftpclient_common.h
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftpclient_main.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftpserver_common.h
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_tftpserver_main.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_web_utils.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_webserver.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_webserver.h
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_ws_http_response.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_ws_main.c
ThirdParty/sw_services/lwip211/examples/freertos_lwip_example_ws_platform_fs.c
ThirdParty/sw_services/lwip211/examples/lwip_example_igmp_app.c
ThirdParty/sw_services/lwip211/examples/lwip_example_igmp_app.h
ThirdParty/sw_services/lwip211/examples/lwip_example_igmp_main.c
ThirdParty/sw_services/lwip211/examples/lwip_example_iic_phyreset.c
ThirdParty/sw_services/lwip211/examples/lwip_example_platform.c
ThirdParty/sw_services/lwip211/examples/lwip_example_platform.h
ThirdParty/sw_services/lwip211/examples/lwip_example_platform_config.h
ThirdParty/sw_services/lwip211/examples/lwip_example_tftp_client.c
ThirdParty/sw_services/lwip211/examples/lwip_example_tftp_platform_fs.c
ThirdParty/sw_services/lwip211/examples/lwip_example_tftp_platform_fs.h
ThirdParty/sw_services/lwip211/examples/lwip_example_tftp_server.c
ThirdParty/sw_services/lwip211/examples/lwip_example_tftpclient_common.h
ThirdParty/sw_services/lwip211/examples/lwip_example_tftpclient_main.c
ThirdParty/sw_services/lwip211/examples/lwip_example_tftpserver_common.h
ThirdParty/sw_services/lwip211/examples/lwip_example_tftpserver_main.c
ThirdParty/sw_services/lwip211/examples/lwip_example_web_utils.c
ThirdParty/sw_services/lwip211/examples/lwip_example_webserver.h
ThirdParty/sw_services/lwip211/examples/lwip_example_ws_http_response.c
ThirdParty/sw_services/lwip211/examples/lwip_example_ws_main.c
ThirdParty/sw_services/lwip211/examples/lwip_example_ws_platform_fs.c
ThirdParty/sw_services/lwip211/examples/lwip_example_ws_platform_fs.h
lib/sw_apps/freertos_lwip_echo_server/src/echo.c
lib/sw_apps/freertos_lwip_echo_server/src/iic_phyreset.c
lib/sw_apps/freertos_lwip_echo_server/src/main.c
lib/sw_apps/freertos_lwip_tcp_perf_client/src/freertos_tcp_perf_client.h
lib/sw_apps/freertos_lwip_tcp_perf_client/src/iic_phyreset.c
lib/sw_apps/freertos_lwip_tcp_perf_client/src/main.c
lib/sw_apps/freertos_lwip_tcp_perf_server/src/freertos_tcp_perf_server.c
lib/sw_apps/freertos_lwip_tcp_perf_server/src/freertos_tcp_perf_server.h
lib/sw_apps/freertos_lwip_tcp_perf_server/src/iic_phyreset.c
lib/sw_apps/freertos_lwip_tcp_perf_server/src/main.c
lib/sw_apps/freertos_lwip_udp_perf_client/src/iic_phyreset.c
lib/sw_apps/freertos_lwip_udp_perf_client/src/main.c
lib/sw_apps/freertos_lwip_udp_perf_client/src/udp_perf_client.h
lib/sw_apps/freertos_lwip_udp_perf_server/src/iic_phyreset.c
lib/sw_apps/freertos_lwip_udp_perf_server/src/main.c
lib/sw_apps/freertos_lwip_udp_perf_server/src/udp_perf_server.h
lib/sw_apps/lwip_echo_server/src/echo.c
lib/sw_apps/lwip_echo_server/src/iic_phyreset.c
lib/sw_apps/lwip_echo_server/src/main.c
lib/sw_apps/lwip_echo_server/src/platform.c
lib/sw_apps/lwip_echo_server/src/platform.h
lib/sw_apps/lwip_tcp_perf_client/src/iic_phyreset.c
lib/sw_apps/lwip_tcp_perf_client/src/main.c
lib/sw_apps/lwip_tcp_perf_client/src/platform.c
lib/sw_apps/lwip_tcp_perf_client/src/platform.h
lib/sw_apps/lwip_tcp_perf_client/src/tcp_perf_client.h
lib/sw_apps/lwip_tcp_perf_server/src/iic_phyreset.c
lib/sw_apps/lwip_tcp_perf_server/src/main.c
lib/sw_apps/lwip_tcp_perf_server/src/platform.c
lib/sw_apps/lwip_tcp_perf_server/src/platform.h
lib/sw_apps/lwip_tcp_perf_server/src/tcp_perf_server.h
lib/sw_apps/lwip_udp_perf_client/src/iic_phyreset.c
lib/sw_apps/lwip_udp_perf_client/src/main.c
lib/sw_apps/lwip_udp_perf_client/src/platform.c
lib/sw_apps/lwip_udp_perf_client/src/platform.h
lib/sw_apps/lwip_udp_perf_client/src/udp_perf_client.h
lib/sw_apps/lwip_udp_perf_server/src/iic_phyreset.c
lib/sw_apps/lwip_udp_perf_server/src/main.c
lib/sw_apps/lwip_udp_perf_server/src/platform.c
lib/sw_apps/lwip_udp_perf_server/src/platform.h
lib/sw_apps/lwip_udp_perf_server/src/udp_perf_server.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file i2c_lib.c This file contains
library functions to initialize, control and access IIC devices. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 srt 10/19/13
Initial Version </pre> / Include Files /

FILES:
ThirdParty/sw_services/lwip202/examples/lwip_example_i2c_access.c
ThirdParty/sw_services/lwip211/examples/lwip_example_i2c_access.c
lib/sw_apps/lwip_echo_server/src/i2c_access.c
lib/sw_apps/lwip_tcp_perf_client/src/i2c_access.c
lib/sw_apps/lwip_tcp_perf_server/src/i2c_access.c
lib/sw_apps/lwip_udp_perf_client/src/i2c_access.c
lib/sw_apps/lwip_udp_perf_server/src/i2c_access.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / platform_mb.c MicroBlaze platform
specific functions. /

FILES:
ThirdParty/sw_services/lwip202/examples/lwip_example_platform_mb.c
ThirdParty/sw_services/lwip211/examples/lwip_example_platform_mb.c
lib/sw_apps/lwip_echo_server/src/platform_mb.c
lib/sw_apps/lwip_tcp_perf_client/src/platform_mb.c
lib/sw_apps/lwip_tcp_perf_server/src/platform_mb.c
lib/sw_apps/lwip_udp_perf_client/src/platform_mb.c
lib/sw_apps/lwip_udp_perf_server/src/platform_mb.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / platform_zynq.c Zynq platform
specific functions. 02/29/2012: UART initialization is removed. Timer
initializations are removed. All unnecessary include files and hash defines are
removed. 03/01/2013: Timer initialization is added back. Support for SI 692601
is added in the timer callback. The SI 692601 refers to the following issue. The
EmacPs has a HW bug on the Rx path for heavy Rx traffic. Under heavy Rx traffic
because of the HW bug there are times when the Rx path becomes unresponsive. The
workaround for it is to check for the Rx path for traffic (by reading the stats
registers regularly). If the stats register does not increment for sometime
(proving no Rx traffic), the function resets the Rx data path. </pre> /

FILES:
ThirdParty/sw_services/lwip202/examples/lwip_example_platform_zynq.c
ThirdParty/sw_services/lwip211/examples/lwip_example_platform_zynq.c
lib/sw_apps/lwip_echo_server/src/platform_zynq.c
lib/sw_apps/lwip_tcp_perf_client/src/platform_zynq.c
lib/sw_apps/lwip_tcp_perf_server/src/platform_zynq.c
lib/sw_apps/lwip_udp_perf_client/src/platform_zynq.c
lib/sw_apps/lwip_udp_perf_server/src/platform_zynq.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / platform_zynqmp.c ZynqMP platform
specific functions. </pre> /

FILES:
ThirdParty/sw_services/lwip202/examples/lwip_example_platform_zynqmp.c
ThirdParty/sw_services/lwip211/examples/lwip_example_platform_zynqmp.c
lib/sw_apps/lwip_echo_server/src/platform_zynqmp.c
lib/sw_apps/lwip_tcp_perf_client/src/platform_zynqmp.c
lib/sw_apps/lwip_tcp_perf_server/src/platform_zynqmp.c
lib/sw_apps/lwip_udp_perf_client/src/platform_zynqmp.c
lib/sw_apps/lwip_udp_perf_server/src/platform_zynqmp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file sfp.c This file programs sfp
phy chip. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 srt 10/19/13 Initial Version </pre> Include Files /

FILES:
ThirdParty/sw_services/lwip202/examples/lwip_example_sfp.c
ThirdParty/sw_services/lwip211/examples/lwip_example_sfp.c
lib/sw_apps/lwip_echo_server/src/sfp.c
lib/sw_apps/lwip_tcp_perf_client/src/sfp.c
lib/sw_apps/lwip_tcp_perf_server/src/sfp.c
lib/sw_apps/lwip_udp_perf_client/src/sfp.c
lib/sw_apps/lwip_udp_perf_server/src/sfp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file si5324.c This file programs
si5324 chip which generates clock for the peripherals. Please refer to Si5324
Datasheet for more information
http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5324.pdf Tested on
Zynq ZC706 platform <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 srt 10/19/13 Initial Version </pre> Include Files /

FILES:
ThirdParty/sw_services/lwip202/examples/lwip_example_si5324.c
ThirdParty/sw_services/lwip211/examples/lwip_example_si5324.c
lib/sw_apps/lwip_echo_server/src/si5324.c
lib/sw_apps/lwip_tcp_perf_client/src/si5324.c
lib/sw_apps/lwip_tcp_perf_server/src/si5324.c
lib/sw_apps/lwip_udp_perf_client/src/si5324.c
lib/sw_apps/lwip_udp_perf_server/src/si5324.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / webserver.c: An example Webserver
application using the RAW API This program serves web pages resident on FAT File
System using lwIP's RAW API. Use of RAW API implies that the webserver is
blazingly fast, but the design is not obvious since a lot of the work happens in
asynchronous callback functions. The webserver works as follows: - on every
accepted connection, only 1 read is performed to identify the file requested.
Further reads are avoided by sending a "Connection: close" in the HTTP response
header - the read determines what file needs to be set (by parsing "GET /
HTTP/1.1" request - once the file to be sent is determined, tcp_write is called
in chunks of size tcp_sndbuf() until the whole file is sent /

FILES:
ThirdParty/sw_services/lwip202/examples/lwip_example_webserver.c
ThirdParty/sw_services/lwip211/examples/lwip_example_webserver.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

sys_arch.c provide sys_arch functionality as required for lwIP most of this
functionality is obtained from xilkernel this file acts as a wrapper around the
xilkernel functions / Copyright (c) 2001-2003 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/sys_arch.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/sys_arch.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2003 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/xlwipconfig.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/sys_arch_raw.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/xlwipconfig.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/sys_arch_raw.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2003 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/arch/cc.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/arch/cpu.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/arch/perf.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/arch/sys_arch.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/httpd/fs.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/httpd/fsdata.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/fs.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/arch/cc.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/arch/cpu.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/arch/perf.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/arch/sys_arch.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/http/fs.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/http/fsdata.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/fs.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. /

FILES:
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/netif/xadapter.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/netif/xaxiemacif.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/netif/xemacliteif.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/netif/xemacpsif.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/netif/xlltemacif.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/netif/xpqueue.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/include/netif/xtopology.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xadapter.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif_dma.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif_fifo.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif_fifo.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif_hw.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif_hw.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif_mcdma.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xaxiemacif_physpeed.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xemac_ieee_reg.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xemacliteif.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xemacpsif.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xemacpsif_dma.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xemacpsif_hw.c
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xemacpsif_hw.h
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xpqueue.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/netif/xadapter.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/netif/xaxiemacif.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/netif/xemacliteif.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/netif/xemacpsif.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/netif/xlltemacif.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/netif/xpqueue.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/include/netif/xtopology.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xadapter.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif_dma.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif_fifo.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif_fifo.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif_hw.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif_hw.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif_mcdma.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xaxiemacif_physpeed.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xemac_ieee_reg.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xemacliteif.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xemacpsif.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xemacpsif_dma.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xemacpsif_hw.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xemacpsif_hw.h
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xpqueue.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. / This file xemacpsif_physpeed.c implements functionalities to: - Detect
the available PHYs connected to a MAC - Negotiate speed - Configure speed -
Configure the SLCR registers for the negotiated speed In a typical use case,
users of the APIs implemented in this file need to do the following. - Call the
API detect_phy. It probes for the available PHYs connected to a MAC. The MACs
can be Emac0 (XPAR_XEMACPS_0_BASEADDR, 0xE000B000) or Emac1
(XPAR_XEMACPS_0_BASEADDR, 0xE000C000). It populates an array to notify about the
detected PHYs. The array phymapemac0 is used for Emac0 and phymapemac1 is for
Emac1. - The users need to parse the corresponding arrays, phymapemac0 or
phymapemac1 to know the available PHYs for a MAC. The users then need to call
phy_setup_emacps to setup the PHYs for proper speed setting. The API
phy_setup_emacps should be called with the PHY address for which the speed needs
to be negotiated or configured. In a specific use case, if 2 PHYs are connected
to Emac0 with addresses of 7 and 11, then users get these address details from
phymapemac0 (after calling detect_phy) and then call phy_setup_emacps twice,
with ab address of 7 and 11. - Points to note: The MAC can operate at only one
speed. If a MAC is connected to multiple PHYs, then all PHYs must negotiate and
configured for the same speed. - This file implements static functions to set
proper SLCR clocks. As stated above, all PHYs connected to a PHY must operate at
same speed and the SLCR clock will be setup accordingly. This file implements
the following PHY types. - The standard RGMII. - It provides support for GMII to
RGMII converter Xilinx IP. This Xilinx IP sits on the MDIO bus with a predefined
PHY address. This IP exposes register that needs to be programmed with the
negotiated speed. For example, in a typical design, the Emac0 or Emac1 exposes
GMII interface. The user can then use the Xilinx IP that converts GMII to RGMII.
The external PHY (most typically Marvell 88E1116R) negotiates for speed with the
remote PHY. The implementation in this file then programs the Xilinx IP with
this negotiated speed. The Xilinx IP has a predefined IP address exposed through
xparameters.h - The SGMII and 1000 BaseX PHY interfaces. If the PHY interface is
SGMII or 1000 BaseX a separate "get_IEEE_phy_speed" is used which is different
from standard RGMII "get_IEEE_phy_speed". The 1000 BaseX always operates at 1000
Mbps. The SGMII interface can negotiate speed accordingly. For SGMII or 1000
BaseX interfaces, the detect_phy should not be called. The phy addresses for
these interfaces are fixed at the design time. Point to note: A MAC can not be
connected to PHYs where there is a mix between SGMII or 1000 Basex or
GMII/MII/RGMII. In a typical multiple PHY designs, it is expected that the PHYs
connected will be RGMII or GMII. The users can choose not to negotiate speed
from lwip settings GUI. If they opt to choose a particular PHY speed, then the
PHY will hard code the speed to operate only at the corresponding speed. It will
not advertise any other speeds. It is users responsibility to ensure that the
remote PHY supports the speed programmed through the lwip gui. The following
combination of MDIO/PHY are supported: - Multiple PHYs connected to the MDIO bus
of a MAC. If Emac0 MDIO is connected to single/multiple PHYs, it is supported.
Similarly Emac1 MDIO connected to single/multiple PHYs is supported. - A design
where both the interfaces are present and are connected to their own MDIO bus is
supported. The following MDIO/PHY setup is not supported: - A design has both
the MACs present. MDIO bus is available only for one MAC (Emac0 or Emac1). This
MDIO bus has multiple PHYs available for both the MACs. The negotiated speed for
PHYs sitting on the MDIO bus of one MAC will not be see for the other MAC and
hence the speed/SLCR settings of the other MAC cannot be programmed. Hence this
kind of design will not work for this implementation.

FILES:
ThirdParty/sw_services/lwip202/src/contrib/ports/xilinx/netif/xemacpsif_physpeed.c
ThirdParty/sw_services/lwip211/src/contrib/ports/xilinx/netif/xemacpsif_physpeed.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001, 2002 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> COREFILES, CORE4FILES: The minimum set of files needed for lwIP.

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/Filelists.mk
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/Filelists.mk
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Sequential API External module @defgroup netconn Netconn API @ingroup
sequential_api Thread-safe, to be called from non-TCPIP threads only. TX/RX
handling based on @ref netbuf (containing @ref pbuf) to avoid copying data
around. @defgroup netconn_common Common functions @ingroup netconn For use with
TCP and UDP @defgroup netconn_tcp TCP only @ingroup netconn TCP only functions
@defgroup netconn_udp UDP only @ingroup netconn UDP only functions / Copyright
(c) 2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/ This is the part of the API that is linked with the application /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/api_lib.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/api_lib.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Network buffer management @defgroup netbuf Network buffers @ingroup
netconn Network buffer descriptor for @ref netconn. Based on @ref pbuf
internally to avoid copying data around.\n Buffers must not be shared accross
multiple threads, all functions except netbuf_new() and netbuf_delete() are not
thread-safe. / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/netbuf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file API functions for name resolving @defgroup netdbapi NETDB API @ingroup
socket / Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Simon
Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/netdb.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/netdb.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file Network Interface Sequential API module @defgroup netifapi NETIF API
@ingroup sequential_api Thread-safe functions to be called from non-TCPIP
threads @defgroup netifapi_netif NETIF related @ingroup netifapi To be called
from non-TCPIP threads / Redistribution and use in source and binary forms, with
or without modification, are permitted provided that the following conditions
are met: 1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer. 2. Redistributions
in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution. 3. The name of the author may not be
used to endorse or promote products derived from this software without specific
prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/netifapi.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/netifapi.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Sockets BSD-Like API module @defgroup socket Socket API @ingroup
sequential_api BSD-style socket API.\n Thread-safe, to be called from non-TCPIP
threads only.\n Can be activated by defining @ref LWIP_SOCKET to 1.\n Header is
in posix/sys/socket.h\b / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> Improved by Marc Boucher
<marc@mbsi.ca> and David Haas <dhaas@alum.rpi.edu> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/api/sockets.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file LWIP HTTP server implementation / Copyright (c) 2001-2003 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> Simon Goldschmidt
/ @defgroup httpd HTTP server @ingroup apps This httpd supports for a
rudimentary server-side-include facility which will replace tags of the form <!
--tag in any file whose extension is .shtml, .shtm or .ssi with strings provided
by an include handler whose pointer is provided to the module via function
http_set_ssi_handler(). Additionally, a simple common gateway interface (CGI)
handling mechanism has been added to allow clients to hook functions to
particular request URIs. To enable SSI support, define label LWIP_HTTPD_SSI in
lwipopts.h. To enable CGI support, define label LWIP_HTTPD_CGI in lwipopts.h. By
default, the server assumes that HTTP headers are already present in each file
stored in the file system. By defining LWIP_HTTPD_DYNAMIC_HEADERS in lwipopts.h,
this behavior can be changed such that the server inserts the headers
automatically based on the extension of the file being served. If this mode is
used, be careful to ensure that the file system image used does not already
contain the header information. File system images without headers can be
created using the makefsfile tool with the -h command line option. Notes about
valid SSI tags The following assumptions are made about tags used in SSI
markers: 1. No tag may contain '-' or whitespace characters within the tag name.
2. Whitespace is allowed between the tag leadin "<!--" and the start of the tag
name and between the tag name and the leadout string "". 3. The maximum tag name
length is LWIP_HTTPD_MAX_TAG_NAME_LEN, currently 8 characters. Notes on CGI
usage The simple CGI support offered here works with GET method requests only
and can handle up to 16 parameters encoded into the URI. The handler function
may not write directly to the HTTP output but must return a filename that the
HTTP server will send to the browser as a response to the incoming CGI request.
The list of supported file types is quite short, so if makefsdata complains
about an unknown extension, make sure to add it (and its doctype) to the
'g_psHTTPHeaders' list. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/httpd/httpd.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/http/httpd.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP iPerf server implementation / @defgroup iperf Iperf server @ingroup
apps This is a simple performance measuring server to check your bandwith using
iPerf2 on a PC as client. It is currently a minimal implementation providing an
IPv4 TCP server only. @todo: implement UDP mode and IPv6 / Copyright (c) 2014
Simon Goldschmidt All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/lwiperf/lwiperf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file MDNS responder implementation @defgroup mdns MDNS @ingroup apps RFC 6762 -
Multicast DNS\n RFC 6763 - DNS-Based Service Discovery\n @verbinclude mdns.txt
Things left to implement: - Probing/conflict resolution - Sending goodbye
messages (zero ttl) - shutdown, DHCP lease about to expire, DHCP turned off... -
Checking that source address of unicast requests are on the same network -
Limiting multicast responses to 1 per second per resource record - Fragmenting
replies if required - Subscribe to netif address/link change events and act on
them (currently needs to be done manually) - Handling multi-packet known answers
- Individual known answer detection for all local IPv6 addresses - Dynamic size
of outgoing packet / Copyright (c) 2015 Verisure Innovation AB All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Erik Ekman
<erik@kryo.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/mdns/mdns.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file MQTT client @defgroup mqtt MQTT client @ingroup apps @verbinclude
mqtt_client.txt / Copyright (c) 2016 Erik Andersson <erian747@gmail.com> All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack Author: Erik Andersson <erian747@gmail.com> @todo: - Handle large outgoing
payloads for PUBLISH messages - Fix restriction of a single topic in each
(UN)SUBSCRIBE message (protocol has support for multiple topics) - Add support
for legacy MQTT protocol version Please coordinate changes and requests with
Erik Andersson Erik Andersson <erian747@gmail.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/mqtt/mqtt.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/mqtt/mqtt.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file NetBIOS name service responder / @defgroup netbiosns NETBIOS responder
@ingroup apps This is an example implementation of a NetBIOS name server. It
responds to name queries for a configurable name. Name resolving is not
supported. Note that the device doesn't broadcast it's own name so can't detect
duplicate names! / Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/netbiosns/netbiosns.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Abstract Syntax Notation One (ISO 8824, 8825) encoding @todo not optimised
(yet), favor correctness over speed, favor speed over size / Copyright (c) 2006
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_asn1.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_asn1.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Abstract Syntax Notation One (ISO 8824, 8825) codec. / Copyright (c) 2006
Axon Digital Design B.V., The Netherlands. Copyright (c) 2016 Elias Oenal. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan Simons
<christiaan.simons@axon.tv> Martin Hentschel <info@cl-soft.de> Elias Oenal
<lwip@eliasoenal.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_asn1.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_asn1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file MIB tree access/construction functions. / Copyright (c) 2006 Axon Digital
Design B.V., The Netherlands. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> Martin Hentschel <info@cl-soft.de> @defgroup
snmp SNMPv2c agent @ingroup apps SNMPv2c compatible agent\n There is also a MIB
compiler and a MIB viewer in lwIP contrib repository (lwip-
contrib/apps/LwipMibCompiler).\n The agent implements the most important MIB2
MIBs including IPv6 support (interfaces, UDP, TCP, SNMP, ICMP, SYSTEM). IP MIB
is an older version whithout IPv6 statistics (TODO).\n Rewritten by Martin
Hentschel <info@cl-soft.de> and Dirk Ziegelmeier <dziegel@gmx.de>\n Work on
SNMPv3 has started, but is not finished.\n 0 Agent Capabilities Features: -
SNMPv2c support. - Low RAM usage - no memory pools, stack only. - MIB2
implementation is separated from SNMP stack. - Support for multiple MIBs
(snmp_set_mibs() call) - e.g. for private MIB. - Simple and generic API for MIB
implementation. - Comfortable node types and helper functions for scalar arrays
and tables. - Counter64, bit and truthvalue datatype support. - Callbacks for
SNMP writes e.g. to implement persistency. - Runs on two APIs: RAW and netconn.
- Async API is gone - the stack now supports netconn API instead, so blocking
operations can be done in MIB calls. SNMP runs in a worker thread when netconn
API is used. - Simplified thread sync support for MIBs - useful when MIBs need
to access variables shared with other threads where no locking is possible. Used
in MIB2 to access lwIP stats from lwIP thread. MIB compiler (code generator): -
Provided in lwIP contrib repository. - Written in C. MIB viewer used Windows
Forms. - Developed on Windows with Visual Studio 2010. - Can be compiled and
used on all platforms with http://www.monodevelop.com/. - Based on a heavily
modified version of of SharpSnmpLib (a4bd05c6afb4) (https://sharpsnmplib.codeple
x.com/SourceControl/network/forks/Nemo157/MIBParserUpdate). - MIB parser, C file
generation framework and LWIP code generation are cleanly separated, which means
the code may be useful as a base for code generation of other SNMP agents.
Notes: - Stack and MIB compiler were used to implement a Profinet device.
Compiled/implemented MIBs: LLDP-MIB, LLDP-EXT-DOT3-MIB, LLDP-EXT-PNO-MIB. SNMPv1
per RFC1157 and SNMPv2c per RFC 3416 Note the S in SNMP stands for "Simple".
Note that "Simple" is relative. SNMP is simple compared to the complex ISO
network management protocols CMIP (Common Management Information Protocol) and
CMOT (CMip Over Tcp). MIB II The standard lwIP stack management information
base. This is a required MIB, so this is always enabled. The groups EGP, CMOT
and transmission are disabled by default. Most mib-2 objects are not writable
except: sysName, sysLocation, sysContact, snmpEnableAuthenTraps. Writing to or
changing the ARP and IP address and route tables is not possible. Note lwIP has
a very limited notion of IP routing. It currently doen't have a route table and
doesn't have a notion of the U,G,H flags. Instead lwIP uses the interface list
with only one default interface acting as a single gateway interface (G) for the
default route. The agent returns a "virtual table" with the default route
0.0.0.0 for the default interface and network routes (no H) for each network
interface in the netif_list. All routes are considered to be up (U). Loading
additional MIBs MIBs can only be added in compile-time, not in run-time. 1
Building the Agent First of all you'll need to add the following define to your
local lwipopts.h: \define LWIP_SNMP 1 and add the source files your makefile.
Note you'll might need to adapt you network driver to update the mib2 variables
for your interface. 2 Running the Agent The following function calls must be
made in your program to actually get the SNMP agent running. Before starting the
agent you should supply pointers for sysContact, sysLocation, and
snmpEnableAuthenTraps. You can do this by calling - snmp_mib2_set_syscontact() -
snmp_mib2_set_syslocation() - snmp_set_auth_traps_enabled() You can register a
callback which is called on successful write access: snmp_set_write_callback().
Additionally you may want to set - snmp_mib2_set_sysdescr() -
snmp_set_device_enterprise_oid() - snmp_mib2_set_sysname() Also before starting
the agent you need to setup one or more trap destinations using these calls: -
snmp_trap_dst_enable() - snmp_trap_dst_ip_set() If you need more than MIB2, set
the MIBs you want to use by snmp_set_mibs(). Finally, enable the agent by
calling snmp_init() @defgroup snmp_core Core @ingroup snmp @defgroup snmp_traps
Traps @ingroup snmp /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_core.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Martin
Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_core_priv.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_core_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) objects and functions. /
Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> / @defgroup snmp_mib2 MIB2 @ingroup snmp /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) ICMP objects and functions. /
Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2_icmp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2_icmp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) INTERFACES objects and functions.
/ Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2_interfaces.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2_interfaces.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) IP objects and functions. /
Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2_ip.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2_ip.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) SNMP objects and functions. /
Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2_snmp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2_snmp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) SYSTEM objects and functions. /
Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2_system.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2_system.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) TCP objects and functions. /
Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2_tcp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2_tcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Management Information Base II (RFC1213) UDP objects and functions. /
Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Dirk Ziegelmeier <dziegel@gmx.de> Christiaan Simons
<christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_mib2_udp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_mib2_udp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP message processing (RFC1157). / Copyright (c) 2006 Axon Digital
Design B.V., The Netherlands. Copyright (c) 2016 Elias Oenal. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Christiaan Simons <christiaan.simons@axon.tv> Martin
Hentschel <info@cl-soft.de> Elias Oenal <lwip@eliasoenal.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_msg.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_msg.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP Agent message handling structures (internal API, do not use in client
code). / Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. Copyright
(c) 2016 Elias Oenal. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan Simons
<christiaan.simons@axon.tv> Martin Hentschel <info@cl-soft.de> Elias Oenal
<lwip@eliasoenal.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_msg.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_msg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP netconn frontend. / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dirk Ziegelmeier
<dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_netconn.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_netconn.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP pbuf stream wrapper implementation (internal API, do not use in
client code). / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_pbuf_stream.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_pbuf_stream.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP pbuf stream wrapper (internal API, do not use in client code). /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Martin
Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_pbuf_stream.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_pbuf_stream.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP RAW API frontend. / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dirk Ziegelmeier
<dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_raw.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_raw.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP scalar node support implementation. / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_scalar.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_scalar.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP table support implementation. / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_table.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_table.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP thread synchronization implementation. / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dirk
Ziegelmeier <dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_threadsync.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_threadsync.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMPv1 traps implementation. / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Martin Hentschel Christiaan Simons <christiaan.simons@axon.tv> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmp_traps.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_traps.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Additional SNMPv3 functionality RFC3414 and RFC3826. / Copyright (c) 2016
Elias Oenal. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Elias Oenal
<lwip@eliasoenal.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmpv3.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmpv3.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmpv3.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmpv3.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Dummy SNMPv3 functions. / Copyright (c) 2016 Elias Oenal. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Elias Oenal <lwip@eliasoenal.com> Dirk Ziegelmeier
<dirk@ziegelmeier.net> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmpv3_dummy.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMPv3 crypto/auth functions implemented for ARM mbedtls. / Copyright (c)
2016 Elias Oenal and Dirk Ziegelmeier. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Elias Oenal
<lwip@eliasoenal.com> Dirk Ziegelmeier <dirk@ziegelmeier.net> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmpv3_mbedtls.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmpv3_mbedtls.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Additional SNMPv3 functionality RFC3414 and RFC3826 (internal API, do not
use in client code). / Copyright (c) 2016 Elias Oenal. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Author: Elias Oenal <lwip@eliasoenal.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/snmp/snmpv3_priv.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmpv3_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNTP client module / Copyright (c) 2007-2009 Frédéric Bernon, Simon
Goldschmidt All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Frédéric Bernon, Simon Goldschmidt / @defgroup sntp SNTP
@ingroup apps This is simple "SNTP" client for the lwIP raw API. It is a minimal
implementation of SNTPv4 as specified in RFC 4330. For a list of some public NTP
servers, see this link : http://support.ntp.org/bin/view/Servers/NTPPoolServers
@todo: - set/change servers at runtime - complete SNTP_CHECK_RESPONSE checks 3
and 4 /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/sntp/sntp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file tftp_server.c @author Logan Gunthorpe <logang@deltatee.com> Dirk
Ziegelmeier <dziegel@gmx.de> @brief Trivial File Transfer Protocol (RFC 1350)
Copyright (c) Deltatee Enterprises Ltd. 2013 All rights reserved. /
Redistribution and use in source and binary forms, with or without
modification,are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. Author: Logan Gunthorpe <logang@deltatee.com> Dirk Ziegelmeier
<dziegel@gmx.de> / @defgroup tftp TFTP server @ingroup apps This is simple TFTP
server for the lwIP raw API. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/apps/tftp/tftp_server.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/tftp/tftp_server.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Common functions used throughout the stack. These are reference
implementations of the byte swapping functions. Again with the aim of being
simple, correct and fully portable. Byte swapping is the second thing you would
want to optimize. You will need to port it to your architecture and in your
cc.h: \define lwip_htons(x) your_htons \define lwip_htonl(x) your_htonl Note
lwip_ntohs() and lwip_ntohl() are merely references to the htonx counterparts.
If you \define them to htons() and htonl(), you should \define
LWIP_DONT_PROVIDE_BYTEORDER_FUNCTIONS to prevent lwIP from defining htonx/ntohx
compatibility macros. @defgroup sys_nonstandard Non-standard functions @ingroup
sys_layer lwIP provides default implementations for non-standard functions.
These can be mapped to OS functions to reduce code footprint if desired. All
defines related to this section must not be placed in lwipopts.h, but in
arch/cc.h! These options cannot be \defined in lwipopts.h since they are not
options of lwIP itself, but options of the lwIP port to your system. / Copyright
(c) 2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/def.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/def.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DNS - host name to IP address resolver. @defgroup dns DNS @ingroup
callbackstyle_api Implements a DNS host name to IP address resolver. The lwIP
DNS resolver functions are used to lookup a host name and map it to a numerical
IP address. It maintains a list of resolved hostnames that can be queried with
the dns_lookup() function. New hostnames can be resolved using the dns_query()
function. The lwIP version of the resolver also adds a non-blocking version of
gethostbyname() that will work with a raw API application. This function checks
for an IP address string first and converts it if it is valid. gethostbyname()
then does a dns_lookup() to see if the name is already in the table. If so, the
IP is returned. If not, a query is issued and the function returns with a
ERR_INPROGRESS status. The app using the dns client must then go into a waiting
state. Once a hostname has been resolved (or found to be non-existent), the
resolver code calls a specified callback function (which must be implemented by
the module that uses the resolver). Multicast DNS queries are supported for
names ending on ".local". However, only "One-Shot Multicast DNS Queries" are
supported (RFC 6762 chapter 5.1), this is not a fully compliant implementation
of continuous mDNS querying! All functions must be called from TCPIP thread.
@see @ref netconn_common for thread-safe access. / Port to lwIP from uIP by Jim
Pettinato April 2007 security fixes and more by Simon Goldschmidt uIP version
Copyright (c) 2002-2003, Adam Dunkels. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / RFC 1035 - Domain
names - implementation and specification RFC 2181 - Clarifications to the DNS
Specification
----------------------------------------------------------------------------/
@todo: define good default values (rfc compliance) / @todo: improve answer
parsing, more checkings... / @todo: check RFC1035 - 7.3. Processing responses /
@todo: one-shot mDNS: dual-stack fallback to another IP version / Includes
----------------------------------------------------------------------------/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/dns.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Incluse internet checksum functions.\n These are some reference
implementations of the checksum algorithm, with the aim of being simple, correct
and fully portable. Checksumming is the first thing you would want to optimize
for your platform. If you create your own version, link it in and in your cc.h
put: \define LWIP_CHKSUM your_checksum_routine Or you can select from the
implementations below by defining LWIP_CHKSUM_ALGORITHM to 1, 2 or 3. /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/inet_chksum.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Common IPv4 and IPv6 code @defgroup ip IP @ingroup callbackstyle_api
@defgroup ip4 IPv4 @ingroup ip @defgroup ip6 IPv6 @ingroup ip @defgroup ipaddr
IP address handling @ingroup infrastructure @defgroup ip4addr IPv4 only @ingroup
ipaddr @defgroup ip6addr IPv6 only @ingroup ipaddr / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ip.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ip.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file Dynamic memory manager This is a lightweight replacement for the standard
C library malloc(). If you want to use the standard C library malloc() instead,
define MEM_LIBC_MALLOC to 1 in your lwipopts.h To let mem_malloc() use pools
(prevents fragmentation and is much faster than a heap but might waste some
memory), define MEM_USE_POOLS to 1, define MEMP_USE_CUSTOM_POOLS to 1 and create
a file "lwippools.h" that includes a list of pools like this (more pools can be
added between _START and _END): Define three pools with sizes 256, 512, and 1512
bytes LWIP_MALLOC_MEMPOOL_START LWIP_MALLOC_MEMPOOL(20, 256)
LWIP_MALLOC_MEMPOOL(10, 512) LWIP_MALLOC_MEMPOOL(5, 1512)
LWIP_MALLOC_MEMPOOL_END / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/mem.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/mem.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Dynamic pool memory manager lwIP has dedicated pools for many structures
(netconn, protocol control blocks, packet buffers, ...). All these pools are
managed here. @defgroup mempool Memory pools @ingroup infrastructure Custom
memory pools / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/memp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/memp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP network interface abstraction @defgroup netif Network interface
(NETIF) @ingroup callbackstyle_api @defgroup netif_ip4 IPv4 address handling
@ingroup netif @defgroup netif_ip6 IPv6 address handling @ingroup netif
@defgroup netif_cd Client data handling Store data (void) on a netif for
application usage. @see @ref LWIP_NUM_NETIF_CLIENT_DATA @ingroup netif /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/netif.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/netif.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Packet buffer management / @defgroup pbuf Packet buffers (PBUF) @ingroup
infrastructure Packets are built from the pbuf data structure. It supports
dynamic memory allocation for packet contents or can reference externally
managed packet contents both in RAM and ROM. Quick allocation for incoming
packets is provided through pools with fixed sized pbufs. A packet may span over
multiple pbufs, chained as a singly linked list. This is called a "pbuf chain".
Multiple packets may be queued, also using this singly linked list. This is
called a "packet queue". So, a packet queue consists of one or more pbuf chains,
each of which consist of one or more pbufs. CURRENTLY, PACKET QUEUES ARE NOT
SUPPORTED!!! Use helper structs to queue multiple packets. The differences
between a pbuf chain and a packet queue are very precise but subtle. The last
pbuf of a packet has a ->tot_len field that equals the ->len field. It can be
found by traversing the list. If the last pbuf of a packet has a ->next field
other than NULL, more packets are on the queue. Therefore, looping through a
pbuf of a single packet, has an loop end condition (tot_len p->len), NOT (next
NULL). Example of custom pbuf usage for zero-copy RX: @code{.c} typedef struct
my_custom_pbuf { struct pbuf_custom p; void dma_descriptor; } my_custom_pbuf_t;
LWIP_MEMPOOL_DECLARE(RX_POOL, 10, sizeof(my_custom_pbuf_t), "Zero-copy RX PBUF
pool"); void my_pbuf_free_custom(void p) { my_custom_pbuf_t my_puf
(my_custom_pbuf_t)p; LOCK_INTERRUPTS();
free_rx_dma_descriptor(my_pbuf->dma_descriptor); LWIP_MEMPOOL_FREE(RX_POOL,
my_pbuf); UNLOCK_INTERRUPTS(); } void eth_rx_irq() { dma_descriptor dma_desc
get_RX_DMA_descriptor_from_ethernet(); my_custom_pbuf_t my_pbuf
(my_custom_pbuf_t)LWIP_MEMPOOL_ALLOC(RX_POOL); my_pbuf->p.custom_free_function
my_pbuf_free_custom; my_pbuf->dma_descriptor dma_desc;
invalidate_cpu_cache(dma_desc->rx_data, dma_desc->rx_length); struct pbuf p
pbuf_alloced_custom(PBUF_RAW, dma_desc->rx_length, PBUF_REF, &my_pbuf->p,
dma_desc->rx_data, dma_desc->max_buffer_size); if(netif->input(p, netif) !
ERR_OK) { pbuf_free(p); } } @endcode / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/pbuf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Implementation of raw protocol PCBs for low-level handling of different
types of protocols besides (or overriding) those already available in lwIP.\n
See also @ref raw_raw @defgroup raw_raw RAW @ingroup callbackstyle_api
Implementation of raw protocol PCBs for low-level handling of different types of
protocols besides (or overriding) those already available in lwIP.\n @see @ref
raw_api / Copyright (c) 2001-2004 Swedish Institute of Computer Science. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/raw.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP Operating System abstraction / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> / @defgroup
sys_layer Porting (system abstraction layer) @ingroup lwip @verbinclude
"sys_arch.txt" @defgroup sys_os OS abstraction layer @ingroup sys_layer No need
to implement functions in this section in NO_SYS mode. @defgroup sys_sem
Semaphores @ingroup sys_os @defgroup sys_mutex Mutexes @ingroup sys_os Mutexes
are recommended to correctly handle priority inversion, especially if you use
LWIP_CORE_LOCKING . @defgroup sys_mbox Mailboxes @ingroup sys_os @defgroup
sys_time Time @ingroup sys_layer @defgroup sys_prot Critical sections @ingroup
sys_layer Used to protect short regions of code against concurrent access. -
Your system is a bare-metal system (probably with an RTOS) and interrupts are
under your control: Implement this as LockInterrupts() / UnlockInterrupts() -
Your system uses an RTOS with deferred interrupt handling from a worker thread:
Implement as a global mutex or lock/unlock scheduler - Your system uses a high-
level OS with e.g. POSIX signals: Implement as a global mutex @defgroup sys_misc
Misc @ingroup sys_os /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Transmission Control Protocol for IP See also @ref tcp_raw @defgroup
tcp_raw TCP @ingroup callbackstyle_api Transmission Control Protocol for IP\n
@see @ref raw_api and @ref netconn Common functions for the TCP implementation,
such as functinos for manipulating the data structures and the TCP timer
functions. TCP functions related to input and output is found in tcp_in.c and
tcp_out.c respectively.\n / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/tcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file User Datagram Protocol module\n The code for the User Datagram Protocol
UDP & UDPLite (RFC 3828).\n See also @ref udp_raw @defgroup udp_raw UDP @ingroup
callbackstyle_api User Datagram Protocol module\n @see @ref raw_api and @ref
netconn / Copyright (c) 2001-2004 Swedish Institute of Computer Science. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> / @todo Check the use of '(struct
udp_pcb).chksum_len_rx'! /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/udp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file AutoIP Automatic LinkLocal IP Configuration This is a AutoIP
implementation for the lwIP TCP/IP stack. It aims to conform with RFC 3927.
@defgroup autoip AUTOIP @ingroup ip4 AUTOIP related functions USAGE: define @ref
LWIP_AUTOIP 1 in your lwipopts.h Options: AUTOIP_TMR_INTERVAL msecs, I recommend
a value of 100. The value must divide 1000 with a remainder almost 0. Possible
values are 1000, 500, 333, 250, 200, 166, 142, 125, 111, 100 .... Without DHCP:
- Call autoip_start() after netif_add(). With DHCP: - define @ref
LWIP_DHCP_AUTOIP_COOP 1 in your lwipopts.h. - Configure your DHCP Client. @see
netifapi_autoip / Copyright (c) 2007 Dominik Spies <kontakt@dspies.de> All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dominik Spies
<kontakt@dspies.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/autoip.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/autoip.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Dynamic Host Configuration Protocol client @defgroup dhcp4 DHCPv4 @ingroup
ip4 DHCP (IPv4) related functions This is a DHCP client for the lwIP TCP/IP
stack. It aims to conform with RFC 2131 and RFC 2132. @todo: - Support for
interfaces other than Ethernet (SLIP, PPP, ...) Options: @ref
DHCP_COARSE_TIMER_SECS (recommended 60 which is a minute) @ref
DHCP_FINE_TIMER_MSECS (recommended 500 which equals TCP coarse timer)
dhcp_start() starts a DHCP client instance which configures the interface by
obtaining an IP address lease and maintaining it. Use dhcp_release() to end the
lease and use dhcp_stop() to remove the DHCP client. @see netifapi_dhcp4 /
Copyright (c) 2001-2004 Leon Woestenberg <leon.woestenberg@gmx.net> Copyright
(c) 2001-2004 Axon Digital Design B.V., The Netherlands. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. The Swedish Institute of Computer
Science and Adam Dunkels are specifically granted permission to redistribute
this source code. Author: Leon Woestenberg <leon.woestenberg@gmx.net> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/dhcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IGMP - Internet Group Management Protocol @defgroup igmp IGMP @ingroup ip4
To be called from TCPIP thread / Copyright (c) 2002 CITEL Technologies Ltd. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of CITEL Technologies Ltd
nor the names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission. THIS
SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL CITEL TECHNOLOGIES OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is a
contribution to the lwIP TCP/IP stack. The Swedish Institute of Computer Science
and Adam Dunkels are specifically granted permission to redistribute this source
code. Note 1) Although the rfc requires V1 AND V2 capability we will only
support v2 since now V1 is very old (August 1989) V1 can be added if required a
debug print and statistic have been implemented to show this up. Note 2) A query
for a specific group address (as opposed to ALLHOSTS) has now been implemented
as I am unsure if it is required a debug print and statistic have been
implemented to show this up. Note 3) The router alert rfc 2113 is implemented in
outgoing packets but not checked rigorously incoming Steve Reynolds RFC 988 -
Host extensions for IP multicasting - V0 RFC 1054 - Host extensions for IP
multicasting RFC 1112 - Host extensions for IP multicasting - V1 RFC 2236 -
Internet Group Management Protocol, Version 2 - V2 <- this code is based on this
RFC (it's the "de facto" standard) RFC 3376 - Internet Group Management
Protocol, Version 3 - V3 RFC 4604 - Using Internet Group Management Protocol
Version 3... - V3+ RFC 2113 - IP Router Alert Option
----------------------------------------------------------------------------/
Includes
----------------------------------------------------------------------------/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv4/igmp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/igmp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DHCPv6. / Copyright (c) 2010 Inico Technologies Ltd. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Ivan Delamer
<delamer@inicotech.com> Please coordinate changes and requests with Ivan Delamer
<delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/dhcp6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Ethernet output for IPv6. Uses ND tables for link-layer addressing. /
Copyright (c) 2010 Inico Technologies Ltd. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Ivan Delamer <delamer@inicotech.com> Please
coordinate changes and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/ethip6.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ethip6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/ethip6.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ethip6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 version of ICMP, as per RFC 4443. / Copyright (c) 2010 Inico
Technologies Ltd. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/icmp6.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/icmp6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/icmp6.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/icmp6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file INET v6 addresses. / Copyright (c) 2010 Inico Technologies Ltd. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Ivan Delamer
<delamer@inicotech.com> Please coordinate changes and requests with Ivan Delamer
<delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/inet6.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/inet6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 layer. / Copyright (c) 2010 Inico Technologies Ltd. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Ivan Delamer
<delamer@inicotech.com> Please coordinate changes and requests with Ivan Delamer
<delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/ip6.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/ip6.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 addresses. / Copyright (c) 2010 Inico Technologies Ltd. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Ivan Delamer
<delamer@inicotech.com> Functions for handling IPv6 addresses. Please coordinate
changes and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/ip6_addr.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/ip6_addr.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 fragmentation and reassembly. / Copyright (c) 2010 Inico Technologies
Ltd. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/ip6_frag.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip6_frag.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/ip6_frag.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip6_frag.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Multicast listener discovery @defgroup mld6 MLD6 @ingroup ip6 Multicast
listener discovery for IPv6. Aims to be compliant with RFC 2710. No support for
MLDv2.\n To be called from TCPIP thread / Copyright (c) 2010 Inico Technologies
Ltd. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> / Based on igmp.c
implementation of igmp v2 protocol /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/mld6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Neighbor discovery and stateless address autoconfiguration for IPv6. Aims
to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862 (Address
autoconfiguration). / Copyright (c) 2010 Inico Technologies Ltd. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Ivan Delamer
<delamer@inicotech.com> Please coordinate changes and requests with Ivan Delamer
<delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/core/ipv6/nd6.c
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/nd6.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/priv/nd6_priv.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/nd6.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/nd6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/nd6_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file netconn API (to be used from non-TCPIP threads) / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/api.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/api.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Support for different processor and compiler architectures / Copyright (c)
2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/arch.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/arch.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file AutoIP Automatic LinkLocal IP Configuration / Copyright (c) 2007 Dominik
Spies <kontakt@dspies.de> All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dominik Spies
<kontakt@dspies.de> This is a AutoIP implementation for the lwIP TCP/IP stack.
It aims to conform with RFC 3927. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/autoip.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/autoip.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Debug messages infrastructure / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/debug.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/debug.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file various utility macros / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/def.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DHCP client API / Copyright (c) 2001-2004 Leon Woestenberg
<leon.woestenberg@gmx.net> Copyright (c) 2001-2004 Axon Digital Design B.V., The
Netherlands. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Leon Woestenberg <leon.woestenberg@gmx.net> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/dhcp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/dhcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 address autoconfiguration as per RFC 4862. / Copyright (c) 2010 Inico
Technologies Ltd. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> IPv6 address
autoconfiguration as per RFC 4862. Please coordinate changes and requests with
Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/dhcp6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file DNS API / lwip DNS resolver header file. Author: Jim Pettinato April 2007
ported from uIP resolv.c Copyright (c) 2002-2003, Adam Dunkels. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/dns.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/dns.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP Error codes / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/err.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/err.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Posix Errno defines / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/errno.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/errno.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Ethernet output function - handles OUTGOING ethernet level traffic,
implements ARP resolving. To be used in most low-level netif implementations /
Copyright (c) 2001-2003 Swedish Institute of Computer Science. Copyright (c)
2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv> Copyright (c) 2003-2004
Axon Digital Design B.V., The Netherlands. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/etharp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/etharp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file ICMP API / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/icmp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/icmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IGMP API / Copyright (c) 2002 CITEL Technologies Ltd. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
Neither the name of CITEL Technologies Ltd nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY CITEL
TECHNOLOGIES AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CITEL
TECHNOLOGIES OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is a contribution to the lwIP TCP/IP stack. The
Swedish Institute of Computer Science and Adam Dunkels are specifically granted
permission to redistribute this source code.

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/igmp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/igmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file This file (together with sockets.h) aims to provide structs and functions
from - arpa/inet.h - netinet/in.h / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/inet.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/inet.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IP checksum calculation functions / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/inet_chksum.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/inet_chksum.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP initialization API / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/init.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/init.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IP API / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv4 API / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip4.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip4.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv4 address API / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip4_addr.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip4_addr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IP fragmentation/reassembly / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Jani Monoses <jani@iv.ro> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip4_frag.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip4_frag.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 addresses. / Copyright (c) 2010 Inico Technologies Ltd. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Ivan Delamer
<delamer@inicotech.com> Structs and macros for handling IPv6 addresses. Please
coordinate changes and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip6_addr.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip6_addr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IP address API (common IPv4 and IPv6) / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/ip_addr.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip_addr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Heap API / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/mem.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/mem.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Memory pool API / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/memp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/memp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Multicast listener discovery for IPv6. Aims to be compliant with RFC 2710.
No support for MLDv2. / Copyright (c) 2010 Inico Technologies Ltd. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Ivan Delamer
<delamer@inicotech.com> Please coordinate changes and requests with Ivan Delamer
<delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/mld6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/mld6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file netbuf API (for netconn API) / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/netbuf.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/netbuf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file NETDB API (sockets) / Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/netdb.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/netdb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file netif API (to be used from TCPIP thread) / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/netif.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/netif.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file netif API (to be used from non-TCPIP threads) / Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/netifapi.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/netifapi.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP Options Configuration / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> / NOTE: || defined __DOXYGEN__ is a
workaround for doxygen bug without this, doxygen does not see the actual define
/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/opt.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/opt.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file pbuf API / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/pbuf.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/pbuf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file raw API (to be used from TCPIP thread)\n See also @ref raw_raw / Copyright
(c) 2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/raw.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/raw.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP support API for implementing netifs and statitics for MIB2 /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Dirk
Ziegelmeier <dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/snmp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/snmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Socket API (to be used from non-TCPIP threads) / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/sockets.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/sockets.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Statistics API (to be used from TCPIP thread) / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/stats.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/stats.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file OS abstraction layer / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/sys.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/sys.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file TCP API (to be used from TCPIP thread)\n See also @ref tcp_raw / Copyright
(c) 2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/tcp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/tcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Functions to sync with TCPIP thread / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/tcpip.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/tcpip.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Timer implementations / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/timeouts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/timeouts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file UDP API (to be used from TCPIP thread)\n See also @ref udp_raw / Copyright
(c) 2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/udp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/udp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file HTTP server / Copyright (c) 2001-2003 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> This version of the file has been
modified by Texas Instruments to offer simple server-side-include (SSI) and
Common Gateway Interface (CGI) capability. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/httpd.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/httpd.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file HTTP server options list / Copyright (c) 2001-2003 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> This version of the file has been
modified by Texas Instruments to offer simple server-side-include (SSI) and
Common Gateway Interface (CGI) capability. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/httpd_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/httpd_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP iPerf server implementation / Copyright (c) 2014 Simon Goldschmidt
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/lwiperf.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/lwiperf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file MQTT client / Copyright (c) 2016 Erik Andersson All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Erik Andersson /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/mqtt.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/mqtt.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file MQTT client options / Copyright (c) 2016 Erik Andersson All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Erik
Andersson /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/mqtt_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/mqtt_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file NETBIOS name service responder / Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/netbiosns.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/netbiosns.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file NETBIOS name service responder options / Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/netbiosns_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/netbiosns_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP server main API - start and basic configuration / Copyright (c) 2001,
2002 Leon Woestenberg <leon.woestenberg@axon.tv> Copyright (c) 2001, 2002 Axon
Digital Design B.V., The Netherlands. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Leon Woestenberg <leon.woestenberg@axon.tv>
Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP core API for implementing MIBs / Copyright (c) 2006 Axon Digital
Design B.V., The Netherlands. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmp_core.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmp_core.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP MIB2 API / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Dirk Ziegelmeier <dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmp_mib2.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmp_mib2.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP server options list / Copyright (c) 2015 Dirk Ziegelmeier All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Dirk
Ziegelmeier /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmp_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmp_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP server MIB API to implement scalar nodes / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmp_scalar.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmp_scalar.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP server MIB API to implement table nodes / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Martin Hentschel <info@cl-soft.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmp_table.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmp_table.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNMP server MIB API to implement thread synchronization / Copyright (c)
2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Dirk Ziegelmeier
<dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/snmp_threadsync.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/snmp_threadsync.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNTP client API / Copyright (c) 2007-2009 Frédéric Bernon, Simon
Goldschmidt All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Frédéric Bernon, Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/sntp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/sntp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNTP client options list / Copyright (c) 2007-2009 Frédéric Bernon,
Simon Goldschmidt All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Frédéric Bernon, Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/sntp_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/sntp_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file tftp_opts.h @author Logan Gunthorpe <logang@deltatee.com> @brief Trivial
File Transfer Protocol (RFC 1350) implementation options Copyright (c) Deltatee
Enterprises Ltd. 2013 All rights reserved. / Redistribution and use in source
and binary forms, with or without modification,are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Logan Gunthorpe
<logang@deltatee.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/tftp_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/tftp_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file tftp_server.h @author Logan Gunthorpe <logang@deltatee.com> @brief Trivial
File Transfer Protocol (RFC 1350) Copyright (c) Deltatee Enterprises Ltd. 2013
All rights reserved. / Redistribution and use in source and binary forms, with
or without modification,are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Logan Gunthorpe
<logang@deltatee.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/apps/tftp_server.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/tftp_server.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file netconn API lwIP internal implementations (do not use in application code)
/ Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/priv/api_msg.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/api_msg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file memory pools lwIP internal implementations (do not use in application
code) / Copyright (c) 2001-2004 Swedish Institute of Computer Science. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/priv/memp_priv.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/memp_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file TCP internal implementations (do not use in application code) / Copyright
(c) 2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/priv/tcp_priv.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/tcp_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file TCPIP API internal implementations (do not use in application code) /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/priv/tcpip_priv.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/tcpip_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file AutoIP protocol definitions / Copyright (c) 2007 Dominik Spies
<kontakt@dspies.de> All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Dominik Spies
<kontakt@dspies.de> This is a AutoIP implementation for the lwIP TCP/IP stack.
It aims to conform with RFC 3927. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/autoip.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/autoip.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DHCP protocol definitions / Copyright (c) 2001-2004 Leon Woestenberg
<leon.woestenberg@gmx.net> Copyright (c) 2001-2004 Axon Digital Design B.V., The
Netherlands. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Leon Woestenberg <leon.woestenberg@gmx.net> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/dhcp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/dhcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DNS - host name to IP address resolver. / Port to lwIP from uIP by Jim
Pettinato April 2007 security fixes and more by Simon Goldschmidt uIP version
Copyright (c) 2002-2003, Adam Dunkels. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/dns.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/dns.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file ARP protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/etharp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/etharp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Ethernet protocol definitions / Copyright (c) 2001-2004 Swedish Institute
of Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/ethernet.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/ethernet.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file ICMP protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/icmp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/icmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file ICMP6 protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/icmp6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/icmp6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IGMP protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/igmp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/igmp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IP protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/ip.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/ip.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv4 protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/ip4.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/ip4.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/ip6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/ip6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file MLD6 protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/mld6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/mld6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file ND6 protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/nd6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/nd6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file TCP protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/tcp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/tcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file UDP protocol definitions / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/lwip/prot/udp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/udp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Ethernet input function - handles INCOMING ethernet level traffic To be
used in most low-level netif implementations / Copyright (c) 2001-2003 Swedish
Institute of Computer Science. Copyright (c) 2003-2004 Leon Woestenberg
<leon.woestenberg@axon.tv> Copyright (c) 2003-2004 Axon Digital Design B.V., The
Netherlands. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ethernet.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ethernet.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file 6LowPAN output for IPv6. Uses ND tables for link-layer addressing.
Fragments packets to 6LowPAN units. / Copyright (c) 2015 Inico Technologies Ltd.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/lowpan6.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/lowpan6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file 6LowPAN options list / Copyright (c) 2015 Inico Technologies Ltd. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/lowpan6_opts.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/lowpan6_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SLIP netif API / Copyright (c) 2001, Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. Neither the name of the
Institute nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/slipif.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/slipif.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ccp.h - Definitions for PPP Compression Control Protocol. Copyright (c)
1994-2002 Paul Mackerras. All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
The name(s) of the authors of this software must not be used to endorse or
promote products derived from this software without prior written permission. 3.
Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by Paul Mackerras <paulus@samba.org>".
THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id:
ccp.h,v 1.12 2004/11/04 10:02:26 paulus Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/ccp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/ccp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

chap-md5.h - New CHAP/MD5 implementation. Copyright (c) 2003 Paul Mackerras. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. The name(s) of the
authors of this software must not be used to endorse or promote products derived
from this software without prior written permission. 3. Redistributions of any
form whatsoever must retain the following acknowledgment: "This product includes
software developed by Paul Mackerras <paulus@samba.org>". THE AUTHORS OF THIS
SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS
BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/chap-md5.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/chap-md5.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

chap-new.c - New CHAP implementation. Copyright (c) 2003 Paul Mackerras. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. The name(s) of the
authors of this software must not be used to endorse or promote products derived
from this software without prior written permission. 3. Redistributions of any
form whatsoever must retain the following acknowledgment: "This product includes
software developed by Paul Mackerras <paulus@samba.org>". THE AUTHORS OF THIS
SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS
BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/chap-new.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/chap-new.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/chap-new.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/chap-new.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

chap_ms.h - Challenge Handshake Authentication Protocol definitions. Copyright
(c) 1995 Eric Rosenquist. All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name(s) of the authors of
this software must not be used to endorse or promote products derived from this
software without prior written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM
ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. $Id: chap_ms.h,v 1.13 2004/11/15 22:13:26 paulus
Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/chap_ms.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/chap_ms.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

eap.h - Extensible Authentication Protocol for PPP (RFC 2284) Copyright (c) 2001
by Sun Microsystems, Inc. All rights reserved. Non-exclusive rights to
redistribute, modify, translate, and use this software in source and binary
forms, in whole or in part, is hereby granted, provided that the above copyright
notice is duplicated in any source form, and that neither the name of the
copyright holder nor the author is used to endorse or promote products derived
from this software. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. Original version by James
Carlson $Id: eap.h,v 1.2 2003/06/11 23:56:26 paulus Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/eap.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/eap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ecp.h - Definitions for PPP Encryption Control Protocol. Copyright (c) 2002
Google, Inc. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name(s) of the authors of
this software must not be used to endorse or promote products derived from this
software without prior written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM
ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. $Id: ecp.h,v 1.2 2003/01/10 07:12:36 fcusack Exp $
/

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/ecp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/ecp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

eui64.h - EUI64 routines for IPv6CP. Copyright (c) 1999 Tommi Komulainen. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name(s) of the authors of this software
must not be used to endorse or promote products derived from this software
without prior written permission. 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Tommi Komulainen <Tommi.Komulainen@iki.fi>". THE AUTHORS OF THIS SOFTWARE
DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: eui64.h,v 1.6 2002/12/04
23:03:32 paulus Exp $

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/eui64.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/eui64.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

fsm.h - {Link, IP} Control Protocol Finite State Machine definitions. Copyright
(c) 1984-2000 Carnegie Mellon University. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
"Carnegie Mellon University" must not be used to endorse or promote products
derived from this software without prior written permission. For permission or
any legal details, please contact Office of Technology Transfer Carnegie Mellon
University 5000 Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax:
(412) 268-7395 tech-transfer@andrew.cmu.edu 4. Redistributions of any form
whatsoever must retain the following acknowledgment: "This product includes
software developed by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: fsm.h,v 1.10 2004/11/13
02:28:15 paulus Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/fsm.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/fsm.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ipcp.h - IP Control Protocol definitions. Copyright (c) 1984-2000 Carnegie
Mellon University. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: ipcp.h,v 1.14 2002/12/04
23:03:32 paulus Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/ipcp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/ipcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ipv6cp.h - PPP IPV6 Control Protocol. Copyright (c) 1999 Tommi Komulainen. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name(s) of the authors of this software
must not be used to endorse or promote products derived from this software
without prior written permission. 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Tommi Komulainen <Tommi.Komulainen@iki.fi>". THE AUTHORS OF THIS SOFTWARE
DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. / Original version, based on
RFC2023 : Copyright (c) 1995, 1996, 1997 Francis.Dupont@inria.fr, INRIA
Rocquencourt, Alain.Durand@imag.fr, IMAG, Jean-Luc.Richier@imag.fr, IMAG-LSR.
Copyright (c) 1998, 1999 Francis.Dupont@inria.fr, GIE DYADE,
Alain.Durand@imag.fr, IMAG, Jean-Luc.Richier@imag.fr, IMAG-LSR. Ce travail a
été fait au sein du GIE DYADE (Groupement d'Intérêt Économique ayant pour
membres BULL S.A. et l'INRIA). Ce logiciel informatique est disponible aux
conditions usuelles dans la recherche, c'est-à-dire qu'il peut être utilisé,
copié, modifié, distribué à l'unique condition que ce texte soit conservé
afin que l'origine de ce logiciel soit reconnue. Le nom de l'Institut National
de Recherche en Informatique et en Automatique (INRIA), de l'IMAG, ou d'une
personne morale ou physique ayant participé à l'élaboration de ce logiciel ne
peut être utilisé sans son accord préalable explicite. Ce logiciel est fourni
tel quel sans aucune garantie, support ou responsabilité d'aucune sorte. Ce
logiciel est dérivé de sources d'origine "University of California at
Berkeley" et "Digital Equipment Corporation" couvertes par des copyrights.
L'Institut d'Informatique et de Mathématiques Appliquées de Grenoble (IMAG)
est une fédération d'unités mixtes de recherche du CNRS, de l'Institut
National Polytechnique de Grenoble et de l'Université Joseph Fourier regroupant
sept laboratoires dont le laboratoire Logiciels, Systèmes, Réseaux (LSR). This
work has been done in the context of GIE DYADE (joint R & D venture between BULL
S.A. and INRIA). This software is available with usual "research" terms with the
aim of retain credits of the software. Permission to use, copy, modify and
distribute this software for any purpose and without fee is hereby granted,
provided that the above copyright notice and this permission notice appear in
all copies, and the name of INRIA, IMAG, or any contributor not be used in
advertising or publicity pertaining to this material without the prior explicit
permission. The software is provided "as is" without any warranties, support or
liabilities of any kind. This software is derived from source code from
"University of California at Berkeley" and "Digital Equipment Corporation"
protected by copyrights. Grenoble's Institute of Computer Science and Applied
Mathematics (IMAG) is a federation of seven research units funded by the CNRS,
National Polytechnic Institute of Grenoble and University Joseph Fourier. The
research unit in Software, Systems, Networks (LSR) is member of IMAG. Derived
from : ipcp.h - IP Control Protocol definitions. Copyright (c) 1984-2000
Carnegie Mellon University. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
"Carnegie Mellon University" must not be used to endorse or promote products
derived from this software without prior written permission. For permission or
any legal details, please contact Office of Technology Transfer Carnegie Mellon
University 5000 Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax:
(412) 268-7395 tech-transfer@andrew.cmu.edu 4. Redistributions of any form
whatsoever must retain the following acknowledgment: "This product includes
software developed by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: ipv6cp.h,v 1.7 2002/12/04
23:03:32 paulus Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/ipv6cp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/ipv6cp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

lcp.h - Link Control Protocol definitions. Copyright (c) 1984-2000 Carnegie
Mellon University. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: lcp.h,v 1.20 2004/11/14
22:53:42 carlsonj Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/lcp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/lcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

magic.h - PPP Magic Number definitions. Copyright (c) 1984-2000 Carnegie Mellon
University. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: magic.h,v 1.5 2003/06/11
23:56:26 paulus Exp $ / randm.h - Random number generator header file. Copyright
(c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc. Copyright (c) 1998
Global Election Systems Inc. The authors hereby grant permission to use, copy,
modify, distribute, and license this software and its documentation for any
purpose, provided that existing copyright notices are retained in all copies and
that this notice and the following disclaimer are included verbatim in any
distributions. No written agreement, license, or royalty fee is required for any
of the authorized uses. THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS AS IS AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. REVISION HISTORY 03-01-01 Marc
Boucher <marc@mbsi.ca> Ported to lwIP. 98-05-29 Guy Lancaster <glanca@gesn.com>,
Global Election Systems Inc. Extracted from avos.

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/magic.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/magic.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

mppe.h - Definitions for MPPE Copyright (c) 2008 Paul Mackerras. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name(s) of the authors of this software must not be
used to endorse or promote products derived from this software without prior
written permission. 4. Redistributions of any form whatsoever must retain the
following acknowledgment: "This product includes software developed by Paul
Mackerras <paulus@samba.org>". THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/mppe.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/mppe.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

ppp.h - Network Point to Point Protocol header file. Copyright (c) 2003 by Marc
Boucher, Services Informatiques (MBSI) inc. portions Copyright (c) 1997 Global
Election Systems Inc. The authors hereby grant permission to use, copy, modify,
distribute, and license this software and its documentation for any purpose,
provided that existing copyright notices are retained in all copies and that
this notice and the following disclaimer are included verbatim in any
distributions. No written agreement, license, or royalty fee is required for any
of the authorized uses. THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS AS IS AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. REVISION HISTORY 03-01-01 Marc
Boucher <marc@mbsi.ca> Ported to lwIP. 97-11-05 Guy Lancaster <glanca@gesn.com>,
Global Election Systems Inc. Original derived from BSD codes.

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/ppp.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/ppp_impl.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/ppp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/ppp_impl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

pppcrypt.c - PPP/DES linkage for MS-CHAP and EAP SRP-SHA1 Extracted from
chap_ms.c by James Carlson. Copyright (c) 1995 Eric Rosenquist. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name(s) of the authors of this software must not be
used to endorse or promote products derived from this software without prior
written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/pppcrypt.h
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/pppcrypt.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/pppcrypt.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/pppcrypt.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

pppdebug.h - System debugging utilities. Copyright (c) 2003 by Marc Boucher,
Services Informatiques (MBSI) inc. portions Copyright (c) 1998 Global Election
Systems Inc. portions Copyright (c) 2001 by Cognizant Pty Ltd. The authors
hereby grant permission to use, copy, modify, distribute, and license this
software and its documentation for any purpose, provided that existing copyright
notices are retained in all copies and that this notice and the following
disclaimer are included verbatim in any distributions. No written agreement,
license, or royalty fee is required for any of the authorized uses. THIS
SOFTWARE IS PROVIDED BY THE CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. REVISION HISTORY (please don't use tabs!) 03-01-01 Marc Boucher
<marc@mbsi.ca> Ported to lwIP. 98-07-29 Guy Lancaster <lancasterg@acm.org>,
Global Election Systems Inc. Original.

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/pppdebug.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/pppdebug.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

pppoe.h - PPP Over Ethernet implementation for lwIP. Copyright (c) 2006 by Marc
Boucher, Services Informatiques (MBSI) inc. The authors hereby grant permission
to use, copy, modify, distribute, and license this software and its
documentation for any purpose, provided that existing copyright notices are
retained in all copies and that this notice and the following disclaimer are
included verbatim in any distributions. No written agreement, license, or
royalty fee is required for any of the authorized uses. THIS SOFTWARE IS
PROVIDED BY THE CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. REVISION HISTORY 06-01-01 Marc Boucher <marc@mbsi.ca> Ported to
lwIP. based on NetBSD: if_pppoe.c,v 1.64 2006/01/31 23:50:15 martin Exp /
Copyright (c) 2002 The NetBSD Foundation, Inc. All rights reserved. This code is
derived from software contributed to The NetBSD Foundation by Martin Husemann
<martin@NetBSD.org>. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. All advertising materials mentioning features
or use of this software must display the following acknowledgement: This product
includes software developed by the NetBSD Foundation, Inc. and its contributors.
4. Neither the name of The NetBSD Foundation nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE NETBSD
FOUNDATION, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/pppoe.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/pppoe.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file Network Point to Point Protocol over Layer 2 Tunneling Protocol header
file. / Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/pppol2tp.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/pppol2tp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file Network Point to Point Protocol over Serial header file. / Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/pppos.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/pppos.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

upap.h - User/Password Authentication Protocol definitions. Copyright (c)
1984-2000 Carnegie Mellon University. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
"Carnegie Mellon University" must not be used to endorse or promote products
derived from this software without prior written permission. For permission or
any legal details, please contact Office of Technology Transfer Carnegie Mellon
University 5000 Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax:
(412) 268-7395 tech-transfer@andrew.cmu.edu 4. Redistributions of any form
whatsoever must retain the following acknowledgment: "This product includes
software developed by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: upap.h,v 1.8 2002/12/04
23:03:33 paulus Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/upap.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/upap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Definitions for tcp compression routines. $Id: vj.h,v 1.7 2010/02/22 17:52:09
goldsimon Exp $ Copyright (c) 1989 Regents of the University of California. All
rights reserved. Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are duplicated in
all such forms and that any documentation, advertising materials, and other
materials related to such distribution and use acknowledge that the software was
developed by the University of California, Berkeley. The name of the University
may not be used to endorse or promote products derived from this software
without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS''
AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION,
THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989: - Initial distribution. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/vj.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/vj.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

\file arc4.h Based on XySSL: Copyright (C) 2006-2008 Christophe Devine Copyright
(C) 2009 Paul Bakker <polarssl_maintainer at polarssl dot org> All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. Redistributions in binary form must
reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the
distribution. Neither the names of PolarSSL or XySSL nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/polarssl/arc4.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/polarssl/arc4.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

\file des.h Based on XySSL: Copyright (C) 2006-2008 Christophe Devine Copyright
(C) 2009 Paul Bakker <polarssl_maintainer at polarssl dot org> All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. Redistributions in binary form must
reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the
distribution. Neither the names of PolarSSL or XySSL nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/polarssl/des.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/polarssl/des.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

\file md4.h Based on XySSL: Copyright (C) 2006-2008 Christophe Devine Copyright
(C) 2009 Paul Bakker <polarssl_maintainer at polarssl dot org> All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. Redistributions in binary form must
reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the
distribution. Neither the names of PolarSSL or XySSL nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/polarssl/md4.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/polarssl/md4.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

\file md5.h Based on XySSL: Copyright (C) 2006-2008 Christophe Devine Copyright
(C) 2009 Paul Bakker <polarssl_maintainer at polarssl dot org> All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. Redistributions in binary form must
reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the
distribution. Neither the names of PolarSSL or XySSL nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/polarssl/md5.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/polarssl/md5.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

\file sha1.h Based on XySSL: Copyright (C) 2006-2008 Christophe Devine Copyright
(C) 2009 Paul Bakker <polarssl_maintainer at polarssl dot org> All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. Redistributions in binary form must
reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the
distribution. Neither the names of PolarSSL or XySSL nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/netif/ppp/polarssl/sha1.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ppp/polarssl/sha1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file This file is a posix wrapper for lwip/errno.h. / Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/posix/errno.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file This file is a posix wrapper for lwip/netdb.h. / Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/posix/netdb.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/compat/posix/netdb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file This file is a posix wrapper for lwip/sockets.h. / Redistribution and use
in source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/include/posix/sys/socket.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/compat/posix/arpa/inet.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/compat/posix/sys/socket.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Ethernet common functions @defgroup ethernet Ethernet @ingroup
callbackstyle_api / Copyright (c) 2001-2003 Swedish Institute of Computer
Science. Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv>
Copyright (c) 2003-2004 Axon Digital Design B.V., The Netherlands. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ethernet.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ethernet.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file 6LowPAN output for IPv6. Uses ND tables for link-layer addressing.
Fragments packets to 6LowPAN units. / Copyright (c) 2015 Inico Technologies Ltd.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> / @defgroup sixlowpan
6LowPAN netif @ingroup addons 6LowPAN netif implementation /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/lowpan6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SLIP Interface / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. Neither the name of the
Institute nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is built
upon the file: src/arch/rtxc/netif/sioslip.c Author: Magnus Ivarsson
<magnus.ivarsson(at)volvo.com> Simon Goldschmidt / @defgroup slipif SLIP netif
@ingroup addons This is an arch independent SLIP netif. The specific serial
hooks must be provided by another file. They are sio_open, sio_read/sio_tryread
and sio_send Usage: This netif can be used in three ways:\n 1) For NO_SYS0, an
RX thread can be used which blocks on sio_read() until data is received.\n 2) In
your main loop, call slipif_poll() to check for new RX bytes, completed packets
are fed into netif->input().\n 3) Call slipif_received_byte[s]() from your
serial RX ISR and slipif_process_rxqueue() from your main loop. ISR level
decodes packets and puts completed packets on a queue which is fed into the
stack from the main loop (needs SYS_LIGHTWEIGHT_PROT for pbuf_alloc to work on
ISR level!). /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/slipif.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

auth.c - PPP authentication and phase control. Copyright (c) 1993-2002 Paul
Mackerras. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2. The
name(s) of the authors of this software must not be used to endorse or promote
products derived from this software without prior written permission. 3.
Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by Paul Mackerras <paulus@samba.org>".
THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Derived
from main.c, which is: Copyright (c) 1984-2000 Carnegie Mellon University. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name "Carnegie Mellon University" must
not be used to endorse or promote products derived from this software without
prior written permission. For permission or any legal details, please contact
Office of Technology Transfer Carnegie Mellon University 5000 Forbes Avenue
Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395 tech-
transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must retain
the following acknowledgment: "This product includes software developed by
Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/auth.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/auth.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ccp.c - PPP Compression Control Protocol. Copyright (c) 1994-2002 Paul
Mackerras. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2. The
name(s) of the authors of this software must not be used to endorse or promote
products derived from this software without prior written permission. 3.
Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by Paul Mackerras <paulus@samba.org>".
THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/ccp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/ccp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

chap-md5.c - New CHAP/MD5 implementation. Copyright (c) 2003 Paul Mackerras. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. The name(s) of the
authors of this software must not be used to endorse or promote products derived
from this software without prior written permission. 3. Redistributions of any
form whatsoever must retain the following acknowledgment: "This product includes
software developed by Paul Mackerras <paulus@samba.org>". THE AUTHORS OF THIS
SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS
BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/chap-md5.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/chap-md5.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

chap_ms.c - Microsoft MS-CHAP compatible implementation. Copyright (c) 1995 Eric
Rosenquist. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name(s) of the authors of
this software must not be used to endorse or promote products derived from this
software without prior written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM
ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. / Modifications by Lauri Pesonen /
lpesonen@clinet.fi, april 1997 Implemented LANManager type password response to
MS-CHAP challenges. Now pppd provides both NT style and LANMan style blocks, and
the prefered is set by option "ms-lanman". Default is to use NT. The hash text
(StdText) was taken from Win95 RASAPI32.DLL. You should also use
DOMAIN\\USERNAME as described in README.MSCHAP80 / Modifications by Frank
Cusack, frank@google.com, March 2002. Implemented MS-CHAPv2 functionality,
heavily based on sample implementation in RFC 2759. Implemented MPPE
functionality, heavily based on sample implementation in RFC 3079. Copyright (c)
2002 Google, Inc. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name(s) of the authors of
this software must not be used to endorse or promote products derived from this
software without prior written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM
ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/chap_ms.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

demand.c - Support routines for demand-dialling. Copyright (c) 1996-2002 Paul
Mackerras. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2. The
name(s) of the authors of this software must not be used to endorse or promote
products derived from this software without prior written permission. 3.
Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by Paul Mackerras <paulus@samba.org>".
THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/demand.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/demand.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

eap.c - Extensible Authentication Protocol for PPP (RFC 2284) Copyright (c) 2001
by Sun Microsystems, Inc. All rights reserved. Non-exclusive rights to
redistribute, modify, translate, and use this software in source and binary
forms, in whole or in part, is hereby granted, provided that the above copyright
notice is duplicated in any source form, and that neither the name of the
copyright holder nor the author is used to endorse or promote products derived
from this software. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. Original version by James
Carlson This implementation of EAP supports MD5-Challenge and SRP-SHA1
authentication styles. Note that support of MD5-Challenge is a requirement of
RFC 2284, and that it's essentially just a reimplementation of regular RFC 1994
CHAP using EAP messages. As an authenticator ("server"), there are multiple
phases for each style. In the first phase of each style, the unauthenticated
peer name is queried using the EAP Identity request type. If the "remotename"
option is used, then this phase is skipped, because the peer's name is presumed
to be known. For MD5-Challenge, there are two phases, and the second phase
consists of sending the challenge itself and handling the associated response.
For SRP-SHA1, there are four phases. The second sends 's', 'N', and 'g'. The
reply contains 'A'. The third sends 'B', and the reply contains 'M1'. The forth
sends the 'M2' value. As an authenticatee ("client"), there's just a single
phase responding to the queries generated by the peer. EAP is an authenticator-
driven protocol. Based on draft-ietf-pppext-eap-srp-03.txt. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/eap.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/eap.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ecp.c - PPP Encryption Control Protocol. Copyright (c) 2002 Google, Inc. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name(s) of the authors of this software
must not be used to endorse or promote products derived from this software
without prior written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. Derived from ccp.c, which is: Copyright (c)
1994-2002 Paul Mackerras. All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
The name(s) of the authors of this software must not be used to endorse or
promote products derived from this software without prior written permission. 3.
Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by Paul Mackerras <paulus@samba.org>".
THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/ecp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/ecp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

eui64.c - EUI64 routines for IPv6CP. Copyright (c) 1999 Tommi Komulainen. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name(s) of the authors of this software
must not be used to endorse or promote products derived from this software
without prior written permission. 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Tommi Komulainen <Tommi.Komulainen@iki.fi>". THE AUTHORS OF THIS SOFTWARE
DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: eui64.c,v 1.6 2002/12/04
23:03:32 paulus Exp $ /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/eui64.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/eui64.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

fsm.c - {Link, IP} Control Protocol Finite State Machine. Copyright (c)
1984-2000 Carnegie Mellon University. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
"Carnegie Mellon University" must not be used to endorse or promote products
derived from this software without prior written permission. For permission or
any legal details, please contact Office of Technology Transfer Carnegie Mellon
University 5000 Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax:
(412) 268-7395 tech-transfer@andrew.cmu.edu 4. Redistributions of any form
whatsoever must retain the following acknowledgment: "This product includes
software developed by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/fsm.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/fsm.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ipcp.c - PPP IP Control Protocol. Copyright (c) 1984-2000 Carnegie Mellon
University. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/ipcp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/ipcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

ipv6cp.c - PPP IPV6 Control Protocol. Copyright (c) 1999 Tommi Komulainen. All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name(s) of the authors of this software
must not be used to endorse or promote products derived from this software
without prior written permission. 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Tommi Komulainen <Tommi.Komulainen@iki.fi>". THE AUTHORS OF THIS SOFTWARE
DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. / Original version, based on
RFC2023 : Copyright (c) 1995, 1996, 1997 Francis.Dupont@inria.fr, INRIA
Rocquencourt, Alain.Durand@imag.fr, IMAG, Jean-Luc.Richier@imag.fr, IMAG-LSR.
Copyright (c) 1998, 1999 Francis.Dupont@inria.fr, GIE DYADE,
Alain.Durand@imag.fr, IMAG, Jean-Luc.Richier@imag.fr, IMAG-LSR. Ce travail a
été fait au sein du GIE DYADE (Groupement d'Intérêt Économique ayant pour
membres BULL S.A. et l'INRIA). Ce logiciel informatique est disponible aux
conditions usuelles dans la recherche, c'est-à-dire qu'il peut être utilisé,
copié, modifié, distribué à l'unique condition que ce texte soit conservé
afin que l'origine de ce logiciel soit reconnue. Le nom de l'Institut National
de Recherche en Informatique et en Automatique (INRIA), de l'IMAG, ou d'une
personne morale ou physique ayant participé à l'élaboration de ce logiciel ne
peut être utilisé sans son accord préalable explicite. Ce logiciel est fourni
tel quel sans aucune garantie, support ou responsabilité d'aucune sorte. Ce
logiciel est dérivé de sources d'origine "University of California at
Berkeley" et "Digital Equipment Corporation" couvertes par des copyrights.
L'Institut d'Informatique et de Mathématiques Appliquées de Grenoble (IMAG)
est une fédération d'unités mixtes de recherche du CNRS, de l'Institut
National Polytechnique de Grenoble et de l'Université Joseph Fourier regroupant
sept laboratoires dont le laboratoire Logiciels, Systèmes, Réseaux (LSR). This
work has been done in the context of GIE DYADE (joint R & D venture between BULL
S.A. and INRIA). This software is available with usual "research" terms with the
aim of retain credits of the software. Permission to use, copy, modify and
distribute this software for any purpose and without fee is hereby granted,
provided that the above copyright notice and this permission notice appear in
all copies, and the name of INRIA, IMAG, or any contributor not be used in
advertising or publicity pertaining to this material without the prior explicit
permission. The software is provided "as is" without any warranties, support or
liabilities of any kind. This software is derived from source code from
"University of California at Berkeley" and "Digital Equipment Corporation"
protected by copyrights. Grenoble's Institute of Computer Science and Applied
Mathematics (IMAG) is a federation of seven research units funded by the CNRS,
National Polytechnic Institute of Grenoble and University Joseph Fourier. The
research unit in Software, Systems, Networks (LSR) is member of IMAG. Derived
from : ipcp.c - PPP IP Control Protocol. Copyright (c) 1984-2000 Carnegie Mellon
University. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. $Id: ipv6cp.c,v 1.21 2005/08/25
23:59:34 paulus Exp $ / @todo: Proxy Neighbour Discovery. Better defines for
selecting the ordering of interface up / set address. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/ipv6cp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/ipv6cp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

lcp.c - PPP Link Control Protocol. Copyright (c) 1984-2000 Carnegie Mellon
University. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/lcp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/lcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

magic.c - PPP Magic Number routines. Copyright (c) 1984-2000 Carnegie Mellon
University. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. / randm.c - Random number
generator program file. Copyright (c) 2003 by Marc Boucher, Services
Informatiques (MBSI) inc. Copyright (c) 1998 by Global Election Systems Inc. The
authors hereby grant permission to use, copy, modify, distribute, and license
this software and its documentation for any purpose, provided that existing
copyright notices are retained in all copies and that this notice and the
following disclaimer are included verbatim in any distributions. No written
agreement, license, or royalty fee is required for any of the authorized uses.
THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. REVISION HISTORY 03-01-01 Marc Boucher <marc@mbsi.ca> Ported to
lwIP. 98-06-03 Guy Lancaster <lancasterg@acm.org>, Global Election Systems Inc.
Extracted from avos.

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/magic.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/magic.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [Google]

COPYRIGHT TEXT:
---------------

mppe.c - interface MPPE to the PPP code. By Frank Cusack <fcusack@fcusack.com>.
Copyright (c) 2002,2003,2004 Google, Inc. All rights reserved. License:
Permission to use, copy, modify, and distribute this software and its
documentation is hereby granted, provided that the above copyright notice
appears in all copies. This software is provided without any warranty, express
or implied. Changelog: 08/12/05 - Matt Domsch <Matt_Domsch@dell.com> Only need
extra skb padding on transmit, not receive. 06/18/04 - Matt Domsch
<Matt_Domsch@dell.com>, Oleg Makarenko <mole@quadra.ru> Use Linux kernel 2.6
arc4 and sha1 routines rather than providing our own. 2/15/04 - TS: added
include <version.h> and testing for Kernel version before using
MOD_DEC_USAGE_COUNT/MOD_INC_USAGE_COUNT which are deprecated in 2.6 /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/mppe.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/mppe.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

multilink.c - support routines for multilink. Copyright (c) 2000-2002 Paul
Mackerras. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2. The
name(s) of the authors of this software must not be used to endorse or promote
products derived from this software without prior written permission. 3.
Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by Paul Mackerras <paulus@samba.org>".
THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/multilink.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/multilink.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

ppp.c - Network Point to Point Protocol program file. Copyright (c) 2003 by Marc
Boucher, Services Informatiques (MBSI) inc. portions Copyright (c) 1997 by
Global Election Systems Inc. The authors hereby grant permission to use, copy,
modify, distribute, and license this software and its documentation for any
purpose, provided that existing copyright notices are retained in all copies and
that this notice and the following disclaimer are included verbatim in any
distributions. No written agreement, license, or royalty fee is required for any
of the authorized uses. THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS AS IS AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. REVISION HISTORY 03-01-01 Marc
Boucher <marc@mbsi.ca> Ported to lwIP. 97-11-05 Guy Lancaster
<lancasterg@acm.org>, Global Election Systems Inc. Original. ppp_defs.h - PPP
definitions. if_pppvar.h - private structures and declarations for PPP.
Copyright (c) 1994 The Australian National University. All rights reserved.
Permission to use, copy, modify, and distribute this software and its
documentation is hereby granted, provided that the above copyright notice
appears in all copies. This software is provided without any warranty, express
or implied. The Australian National University makes no representations about
the suitability of this software for any purpose. IN NO EVENT SHALL THE
AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS
SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUSTRALIAN NATIONAL UNIVERSITY HAVE
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE AUSTRALIAN NATIONAL
UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE AUSTRALIAN
NATIONAL UNIVERSITY HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS. / if_ppp.h - Point-to-Point Protocol
definitions. Copyright (c) 1989 Carnegie Mellon University. All rights reserved.
Redistribution and use in source and binary forms are permitted provided that
the above copyright notice and this paragraph are duplicated in all such forms
and that any documentation, advertising materials, and other materials related
to such distribution and use acknowledge that the software was developed by
Carnegie Mellon University. The name of the University may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. / @defgroup ppp PPP netif
@ingroup addons @verbinclude "ppp.txt" /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/ppp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file Point To Point Protocol Sequential API module / Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/pppapi.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/pppapi.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

pppoe.c - PPP Over Ethernet implementation for lwIP. Copyright (c) 2006 by Marc
Boucher, Services Informatiques (MBSI) inc. The authors hereby grant permission
to use, copy, modify, distribute, and license this software and its
documentation for any purpose, provided that existing copyright notices are
retained in all copies and that this notice and the following disclaimer are
included verbatim in any distributions. No written agreement, license, or
royalty fee is required for any of the authorized uses. THIS SOFTWARE IS
PROVIDED BY THE CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. REVISION HISTORY 06-01-01 Marc Boucher <marc@mbsi.ca> Ported to
lwIP. based on NetBSD: if_pppoe.c,v 1.64 2006/01/31 23:50:15 martin Exp /
Copyright (c) 2002 The NetBSD Foundation, Inc. All rights reserved. This code is
derived from software contributed to The NetBSD Foundation by Martin Husemann
<martin@NetBSD.org>. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. All advertising materials mentioning features
or use of this software must display the following acknowledgement: This product
includes software developed by the NetBSD Foundation, Inc. and its contributors.
4. Neither the name of The NetBSD Foundation nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE NETBSD
FOUNDATION, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/pppoe.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/pppoe.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file Network Point to Point Protocol over Layer 2 Tunneling Protocol program
file. / Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. / L2TP Support
status: Supported: - L2TPv2 (PPP over L2TP, a.k.a. UDP tunnels) - LAC Not
supported: - LNS (require PPP server support) - L2TPv3 ethernet pseudowires -
L2TPv3 VLAN pseudowire - L2TPv3 PPP pseudowires - L2TPv3 IP encapsulation -
L2TPv3 IP pseudowire - L2TP tunnel switching - http://tools.ietf.org/html/draft-
ietf-l2tpext-tunnel-switching-08 - Multiple tunnels per UDP socket, as well as
multiple sessions per tunnel - Hidden AVPs /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/pppol2tp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/pppol2tp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file Network Point to Point Protocol over Serial file. / Redistribution and use
in source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/pppos.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/pppos.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

upap.c - User/Password Authentication Protocol. Copyright (c) 1984-2000 Carnegie
Mellon University. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name "Carnegie Mellon
University" must not be used to endorse or promote products derived from this
software without prior written permission. For permission or any legal details,
please contact Office of Technology Transfer Carnegie Mellon University 5000
Forbes Avenue Pittsburgh, PA 15213-3890 (412) 268-4387, fax: (412) 268-7395
tech-transfer@andrew.cmu.edu 4. Redistributions of any form whatsoever must
retain the following acknowledgment: "This product includes software developed
by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/)." CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE
LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/upap.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/upap.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

utils.c - various utility functions used in pppd. Copyright (c) 1999-2002 Paul
Mackerras. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2. The
name(s) of the authors of this software must not be used to endorse or promote
products derived from this software without prior written permission. 3.
Redistributions of any form whatsoever must retain the following acknowledgment:
"This product includes software developed by Paul Mackerras <paulus@samba.org>".
THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/utils.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/utils.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Routines to compress and uncompess tcp packets (for transmission over low speed
serial lines. Copyright (c) 1989 Regents of the University of California. All
rights reserved. Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are duplicated in
all such forms and that any documentation, advertising materials, and other
materials related to such distribution and use acknowledge that the software was
developed by the University of California, Berkeley. The name of the University
may not be used to endorse or promote products derived from this software
without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS''
AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION,
THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989: Initial distribution.
Modified June 1993 by Paul Mackerras, paulus@cs.anu.edu.au, so that the entire
packet being decompressed doesn't have to be in contiguous memory (just the
compressed header). Modified March 1998 by Guy Lancaster, glanca@gesn.com, for a
16 bit processor. /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/vj.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/vj.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

An implementation of the ARCFOUR algorithm Based on XySSL: Copyright (C)
2006-2008 Christophe Devine Copyright (C) 2009 Paul Bakker <polarssl_maintainer
at polarssl dot org> All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. Neither the names of PolarSSL or
XySSL nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / The ARCFOUR
algorithm was publicly disclosed on 94/09.
http://groups.google.com/group/sci.crypt/msg/10a300c9d21afca0 /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/polarssl/arc4.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/polarssl/arc4.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

FIPS-46-3 compliant Triple-DES implementation Based on XySSL: Copyright (C)
2006-2008 Christophe Devine Copyright (C) 2009 Paul Bakker <polarssl_maintainer
at polarssl dot org> All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. Neither the names of PolarSSL or
XySSL nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / DES, on which
TDES is based, was originally designed by Horst Feistel at IBM in 1974, and was
adopted as a standard by NIST (formerly NBS).
http://csrc.nist.gov/publications/fips/fips46-3/fips46-3.pdf /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/polarssl/des.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/polarssl/des.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

RFC 1186/1320 compliant MD4 implementation Based on XySSL: Copyright (C)
2006-2008 Christophe Devine Copyright (C) 2009 Paul Bakker <polarssl_maintainer
at polarssl dot org> All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. Neither the names of PolarSSL or
XySSL nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / The MD4 algorithm
was designed by Ron Rivest in 1990. http://www.ietf.org/rfc/rfc1186.txt
http://www.ietf.org/rfc/rfc1320.txt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/polarssl/md4.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/polarssl/md4.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

RFC 1321 compliant MD5 implementation Based on XySSL: Copyright (C) 2006-2008
Christophe Devine Copyright (C) 2009 Paul Bakker <polarssl_maintainer at
polarssl dot org> All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. Neither the names of PolarSSL or
XySSL nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / The MD5 algorithm
was designed by Ron Rivest in 1991. http://www.ietf.org/rfc/rfc1321.txt /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/polarssl/md5.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/polarssl/md5.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

FIPS-180-1 compliant SHA-1 implementation Based on XySSL: Copyright (C)
2006-2008 Christophe Devine Copyright (C) 2009 Paul Bakker <polarssl_maintainer
at polarssl dot org> All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. Neither the names of PolarSSL or
XySSL nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / The SHA-1
standard was published by NIST in 1993.
http://www.itl.nist.gov/fipspubs/fip180-1.htm /

FILES:
ThirdParty/sw_services/lwip202/src/lwip-2.0.2/src/netif/ppp/polarssl/sha1.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/polarssl/sha1.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Interface Identification APIs from: RFC 3493: Basic Socket Interface
Extensions for IPv6 Section 4: Interface Identification @defgroup if_api
Interface Identification API @ingroup socket / Copyright (c) 2017 Joel
Cunningham, Garmin International, Inc. <joel.cunningham@garmin.com> All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Joel
Cunningham <joel.cunningham@me.com> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/if_api.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Network buffer management @defgroup netbuf Network buffers @ingroup
netconn Network buffer descriptor for @ref netconn. Based on @ref pbuf
internally to avoid copying data around.\n Buffers must not be shared across
multiple threads, all functions except netbuf_new() and netbuf_delete() are not
thread-safe. / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/api/netbuf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP/TLS connection API (to be used from TCPIP thread)
This file provides a TLS layer using mbedTLS / Copyright (c) 2017 Simon
Goldschmidt All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> Watch out: - 'sent' is
always called with len0 to the upper layer. This is because keeping track of the
ratio of application data and TLS overhead would be too much. Mandatory
security-related configuration: - define ALTCP_MBEDTLS_RNG_FN to
mbedtls_entropy_func to use the standard mbedTLS entropy and ensure to add at
least one strong entropy source to your mbedtls port (implement
mbedtls_platform_entropy_poll or mbedtls_hardware_poll providing strong entropy)
- define ALTCP_MBEDTLS_ENTROPY_PTR and ALTCP_MBEDTLS_ENTROPY_LEN to something
providing GOOD custom entropy Missing things / @todo: - some unhandled/untested
things migh be caught by LWIP_ASSERTs... /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/altcp_tls/altcp_tls_mbedtls.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP connection API (to be used from TCPIP thread) This
file contains memory management functions for a TLS layer using mbedTLS.
ATTENTION: For production usage, you might want to override this file with your
own implementation since this implementation simply uses the lwIP heap without
caring for fragmentation or leaving heap for other parts of lwIP! / Copyright
(c) 2017 Simon Goldschmidt All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> Missing things / @todo: - RX
data is acknowledged after receiving (tcp_recved is called when enqueueing the
pbuf for mbedTLS receive, not when processed by mbedTLS or the inner connection;
altcp_recved() from inner connection does nothing) - TX data is marked as 'sent'
(i.e. acknowledged; sent callback is called) right after enqueueing for
transmission, not when actually ACKed be the remote host. /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/altcp_tls/altcp_tls_mbedtls_mem.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP/TLS connection API (to be used from TCPIP thread)
This file contains memory management function prototypes for a TLS layer using
mbedTLS. Memory management contains: - allocating/freeing altcp_mbedtls_state_t
- allocating/freeing memory used in the mbedTLS library / Copyright (c) 2017
Simon Goldschmidt All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/altcp_tls/altcp_tls_mbedtls_mem.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP/TLS connection API (to be used from TCPIP thread)
This file contains structure definitions for a TLS layer using mbedTLS. /
Copyright (c) 2017 Simon Goldschmidt All rights reserved. Redistribution and use
in source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/altcp_tls/altcp_tls_mbedtls_structs.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP connection API that executes a proxy-connect. This
file provides a starting layer that executes a proxy-connect e.g. to set up TLS
connections through a http proxy. / Copyright (c) 2018 Simon Goldschmidt All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/http/altcp_proxyconnect.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/altcp_proxyconnect.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file HTTP client / Copyright (c) 2018 Simon Goldschmidt <goldsimon@gmx.de> All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> / @defgroup httpc HTTP
client @ingroup apps @todo: - persistent connections - select outgoing http
version - optionally follow redirect - check request uri for invalid characters?
(e.g. encode spaces) - IPv6 support /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/http/http_client.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

Copyright (c) 2013-2017, tinydir authors: Cong Xu Lautis Sun Baudouin Feildel
Andargor <andargor@yahoo.com> All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. THIS
SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/http/makefsdata/tinydir.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP iPerf server implementation / @defgroup iperf Iperf server @ingroup
apps This is a simple performance measuring client/server to check your
bandwidth using iPerf2 on a PC as server/client. It is currently a minimal
implementation providing a TCP client/server only. @todo: - implement UDP mode -
protect combined sessions handling (via 'related_master_state') against
reallocation (this is a pointer address, currently, so if the same memory is
allocated again, session pairs (tx/rx) can be confused on reallocation) /
Copyright (c) 2014 Simon Goldschmidt All rights reserved. Redistribution and use
in source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Simon Goldschmidt /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/lwiperf/lwiperf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file MDNS responder implementation @defgroup mdns MDNS @ingroup apps RFC 6762 -
Multicast DNS\n RFC 6763 - DNS-Based Service Discovery\n @verbinclude mdns.txt
Things left to implement: - Tiebreaking for simultaneous probing - Sending
goodbye messages (zero ttl) - shutdown, DHCP lease about to expire, DHCP turned
off... - Checking that source address of unicast requests are on the same
network - Limiting multicast responses to 1 per second per resource record -
Fragmenting replies if required - Handling multi-packet known answers -
Individual known answer detection for all local IPv6 addresses - Dynamic size of
outgoing packet / Copyright (c) 2015 Verisure Innovation AB All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Erik Ekman <erik@kryo.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/mdns/mdns.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file MIB tree access/construction functions. / Copyright (c) 2006 Axon Digital
Design B.V., The Netherlands. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Christiaan
Simons <christiaan.simons@axon.tv> Martin Hentschel <info@cl-soft.de> @defgroup
snmp SNMPv2c/v3 agent @ingroup apps SNMPv2c and SNMPv3 compatible agent\n There
is also a MIB compiler and a MIB viewer in lwIP contrib repository (lwip-
contrib/apps/LwipMibCompiler).\n The agent implements the most important MIB2
MIBs including IPv6 support (interfaces, UDP, TCP, SNMP, ICMP, SYSTEM). IP MIB
is an older version without IPv6 statistics (TODO).\n Rewritten by Martin
Hentschel <info@cl-soft.de> and Dirk Ziegelmeier <dziegel@gmx.de>\n 0 Agent
Capabilities Features: - SNMPv2c support. - SNMPv3 support (a port to ARM
mbedtls is provided, LWIP_SNMP_V3_MBEDTLS option). - Low RAM usage - no memory
pools, stack only. - MIB2 implementation is separated from SNMP stack. - Support
for multiple MIBs (snmp_set_mibs() call) - e.g. for private MIB. - Simple and
generic API for MIB implementation. - Comfortable node types and helper
functions for scalar arrays and tables. - Counter64, bit and truthvalue datatype
support. - Callbacks for SNMP writes e.g. to implement persistency. - Runs on
two APIs: RAW and netconn. - Async API is gone - the stack now supports netconn
API instead, so blocking operations can be done in MIB calls. SNMP runs in a
worker thread when netconn API is used. - Simplified thread sync support for
MIBs - useful when MIBs need to access variables shared with other threads where
no locking is possible. Used in MIB2 to access lwIP stats from lwIP thread. MIB
compiler (code generator): - Provided in lwIP contrib repository. - Written in
C. MIB viewer used Windows Forms. - Developed on Windows with Visual Studio
2010. - Can be compiled and used on all platforms with
http://www.monodevelop.com/. - Based on a heavily modified version of of
SharpSnmpLib (a4bd05c6afb4) (https://sharpsnmplib.codeplex.com/SourceControl/net
work/forks/Nemo157/MIBParserUpdate). - MIB parser, C file generation framework
and LWIP code generation are cleanly separated, which means the code may be
useful as a base for code generation of other SNMP agents. Notes: - Stack and
MIB compiler were used to implement a Profinet device. Compiled/implemented
MIBs: LLDP-MIB, LLDP-EXT-DOT3-MIB, LLDP-EXT-PNO-MIB. SNMPv1 per RFC1157 and
SNMPv2c per RFC 3416 Note the S in SNMP stands for "Simple". Note that "Simple"
is relative. SNMP is simple compared to the complex ISO network management
protocols CMIP (Common Management Information Protocol) and CMOT (CMip Over
Tcp). SNMPv3 When SNMPv3 is used, several functions from snmpv3.h must be
implemented by the user. This is mainly user management and persistence
handling. The sample provided in lwip-contrib is insecure, don't use it in
production systems, especially the missing persistence for engine boots variable
simplifies replay attacks. MIB II The standard lwIP stack management information
base. This is a required MIB, so this is always enabled. The groups EGP, CMOT
and transmission are disabled by default. Most mib-2 objects are not writable
except: sysName, sysLocation, sysContact, snmpEnableAuthenTraps. Writing to or
changing the ARP and IP address and route tables is not possible. Note lwIP has
a very limited notion of IP routing. It currently doesn't have a route table and
doesn't have a notion of the U,G,H flags. Instead lwIP uses the interface list
with only one default interface acting as a single gateway interface (G) for the
default route. The agent returns a "virtual table" with the default route
0.0.0.0 for the default interface and network routes (no H) for each network
interface in the netif_list. All routes are considered to be up (U). Loading
additional MIBs MIBs can only be added in compile-time, not in run-time. 1
Building the Agent First of all you'll need to add the following define to your
local lwipopts.h: \define LWIP_SNMP 1 and add the source files your makefile.
Note you'll might need to adapt you network driver to update the mib2 variables
for your interface. 2 Running the Agent The following function calls must be
made in your program to actually get the SNMP agent running. Before starting the
agent you should supply pointers for sysContact, sysLocation, and
snmpEnableAuthenTraps. You can do this by calling - snmp_mib2_set_syscontact() -
snmp_mib2_set_syslocation() - snmp_set_auth_traps_enabled() You can register a
callback which is called on successful write access: snmp_set_write_callback().
Additionally you may want to set - snmp_mib2_set_sysdescr() -
snmp_set_device_enterprise_oid() - snmp_mib2_set_sysname() Also before starting
the agent you need to setup one or more trap destinations using these calls: -
snmp_trap_dst_enable() - snmp_trap_dst_ip_set() If you need more than MIB2, set
the MIBs you want to use by snmp_set_mibs(). Finally, enable the agent by
calling snmp_init() @defgroup snmp_core Core @ingroup snmp @defgroup snmp_traps
Traps @ingroup snmp /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/snmp/snmp_core.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SNTP client module / Copyright (c) 2007-2009 Frédéric Bernon, Simon
Goldschmidt All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Frédéric Bernon, Simon Goldschmidt / @defgroup sntp SNTP
@ingroup apps This is simple "SNTP" client for the lwIP raw API. It is a minimal
implementation of SNTPv4 as specified in RFC 4330. For a list of some public NTP
servers, see this link: http://support.ntp.org/bin/view/Servers/NTPPoolServers
@todo: - complete SNTP_CHECK_RESPONSE checks 3 and 4 /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/apps/sntp/sntp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [EPL-1.0] [Google]

COPYRIGHT TEXT:
---------------

@file @defgroup altcp Application layered TCP Functions @ingroup altcp_api This
file contains the common functions for altcp to work. For more details see @ref
altcp_api. / @defgroup altcp_api Application layered TCP Introduction @ingroup
callbackstyle_api Overview altcp (application layered TCP connection API; to be
used from TCPIP thread) is an abstraction layer that prevents applications
linking hard against the @ref tcp.h functions while providing the same
functionality. It is used to e.g. add SSL/TLS (see LWIP_ALTCP_TLS) or proxy-
connect support to an application written for the tcp callback API without that
application knowing the protocol details. This interface mimics the tcp callback
API to the application while preventing direct linking (much like virtual
functions). This way, an application can make use of other application layer
protocols on top of TCP without knowing the details (e.g. TLS, proxy
connection). This is achieved by simply including "lwip/altcp.h" instead of
"lwip/tcp.h", replacing "struct tcp_pcb" with "struct altcp_pcb" and prefixing
all functions with "altcp_" instead of "tcp_". With altcp support disabled
(LWIP_ALTCP0), applications written against the altcp API can still be compiled
but are directly linked against the tcp.h callback API and then cannot use
layered protocols. To minimize code changes in this case, the use of
altcp_allocators is strongly suggested. Usage To make use of this API from an
existing tcp raw API application: Include "lwip/altcp.h" instead of "lwip/tcp.h"
Replace "struct tcp_pcb" with "struct altcp_pcb" Prefix all called tcp API
functions with "altcp_" instead of "tcp_" to link against the altcp functions
@ref altcp_new (and @ref altcp_new_ip_type/@ref altcp_new_ip6) take an @ref
altcp_allocator_t as an argument, whereas the original tcp API functions take no
arguments. An @ref altcp_allocator_t allocator is an object that holds a pointer
to an allocator object and a corresponding state (e.g. for TLS, the
corresponding state may hold certificates or keys). This way, the application
does not even need to know if it uses TLS or pure TCP, this is handled at
runtime by passing a specific allocator. An application can alternatively bind
hard to the altcp_tls API by calling @ref altcp_tls_new or @ref altcp_tls_wrap.
The TLS layer is not directly implemented by lwIP, but a port to mbedTLS is
provided. Another altcp layer is proxy-connect to use TLS behind a HTTP proxy
(see @ref altcp_proxyconnect.h) altcp_allocator_t An altcp allocator is created
by the application by combining an allocator callback function and a
corresponding state, e.g.:\code{.c} static const unsigned char cert[] {0x2D, ...
(see mbedTLS doc for how to create this)}; struct altcp_tls_config conf
altcp_tls_create_config_client(cert, sizeof(cert)); altcp_allocator_t
tls_allocator { altcp_tls_alloc, conf }; \endcode struct altcp_tls_config The
struct altcp_tls_config holds state that is needed to create new TLS client or
server connections (e.g. certificates and private keys). It is not defined by
lwIP itself but by the TLS port (e.g. altcp_tls to mbedTLS adaption). However,
the parameters used to create it are defined in @ref altcp_tls.h (see @ref
altcp_tls_create_config_server_privkey_cert for servers and @ref
altcp_tls_create_config_client/@ref altcp_tls_create_config_client_2wayauth for
clients). For mbedTLS, ensure that certificates can be parsed by
'mbedtls_x509_crt_parse()' and private keys can be parsed by
'mbedtls_pk_parse_key()'. / Copyright (c) 2017 Simon Goldschmidt All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Simon
Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/altcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP connection API (to be used from TCPIP thread)\n
This interface mimics the tcp callback API to the application while preventing
direct linking (much like virtual functions). This way, an application can make
use of other application layer protocols on top of TCP without knowing the
details (e.g. TLS, proxy connection). This file contains allocation
implementation that combine several layers. / Copyright (c) 2017 Simon
Goldschmidt All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/altcp_alloc.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP connection API (to be used from TCPIP thread)\n
This interface mimics the tcp callback API to the application while preventing
direct linking (much like virtual functions). This way, an application can make
use of other application layer protocols on top of TCP without knowing the
details (e.g. TLS, proxy connection). This file contains the base implementation
calling into tcp. / Copyright (c) 2017 Simon Goldschmidt All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Simon Goldschmidt
<goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/altcp_tcp.c
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/altcp_tcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DNS - host name to IP address resolver. @defgroup dns DNS @ingroup
callbackstyle_api Implements a DNS host name to IP address resolver. The lwIP
DNS resolver functions are used to lookup a host name and map it to a numerical
IP address. It maintains a list of resolved hostnames that can be queried with
the dns_lookup() function. New hostnames can be resolved using the dns_query()
function. The lwIP version of the resolver also adds a non-blocking version of
gethostbyname() that will work with a raw API application. This function checks
for an IP address string first and converts it if it is valid. gethostbyname()
then does a dns_lookup() to see if the name is already in the table. If so, the
IP is returned. If not, a query is issued and the function returns with a
ERR_INPROGRESS status. The app using the dns client must then go into a waiting
state. Once a hostname has been resolved (or found to be non-existent), the
resolver code calls a specified callback function (which must be implemented by
the module that uses the resolver). Multicast DNS queries are supported for
names ending on ".local". However, only "One-Shot Multicast DNS Queries" are
supported (RFC 6762 chapter 5.1), this is not a fully compliant implementation
of continuous mDNS querying! All functions must be called from TCPIP thread.
@see DNS_MAX_SERVERS @see LWIP_DHCP_MAX_DNS_SERVERS @see @ref netconn_common for
thread-safe access. / Port to lwIP from uIP by Jim Pettinato April 2007 security
fixes and more by Simon Goldschmidt uIP version Copyright (c) 2002-2003, Adam
Dunkels. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / RFC 1035 - Domain names -
implementation and specification RFC 2181 - Clarifications to the DNS
Specification
----------------------------------------------------------------------------/
@todo: define good default values (rfc compliance) / @todo: improve answer
parsing, more checkings... / @todo: check RFC1035 - 7.3. Processing responses /
@todo: one-shot mDNS: dual-stack fallback to another IP version / Includes
----------------------------------------------------------------------------/

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/dns.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Internet checksum functions.\n These are some reference implementations of
the checksum algorithm, with the aim of being simple, correct and fully
portable. Checksumming is the first thing you would want to optimize for your
platform. If you create your own version, link it in and in your cc.h put:
\define LWIP_CHKSUM your_checksum_routine Or you can select from the
implementations below by defining LWIP_CHKSUM_ALGORITHM to 1, 2 or 3. /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/inet_chksum.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Packet buffer management / @defgroup pbuf Packet buffers (PBUF) @ingroup
infrastructure Packets are built from the pbuf data structure. It supports
dynamic memory allocation for packet contents or can reference externally
managed packet contents both in RAM and ROM. Quick allocation for incoming
packets is provided through pools with fixed sized pbufs. A packet may span over
multiple pbufs, chained as a singly linked list. This is called a "pbuf chain".
Multiple packets may be queued, also using this singly linked list. This is
called a "packet queue". So, a packet queue consists of one or more pbuf chains,
each of which consist of one or more pbufs. CURRENTLY, PACKET QUEUES ARE NOT
SUPPORTED!!! Use helper structs to queue multiple packets. The differences
between a pbuf chain and a packet queue are very precise but subtle. The last
pbuf of a packet has a ->tot_len field that equals the ->len field. It can be
found by traversing the list. If the last pbuf of a packet has a ->next field
other than NULL, more packets are on the queue. Therefore, looping through a
pbuf of a single packet, has an loop end condition (tot_len p->len), NOT (next
NULL). Example of custom pbuf usage: @ref zerocopyrx / Copyright (c) 2001-2004
Swedish Institute of Computer Science. All rights reserved. Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/pbuf.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Implementation of raw protocol PCBs for low-level handling of different
types of protocols besides (or overriding) those already available in lwIP.\n
See also @ref raw_raw @defgroup raw_raw RAW @ingroup callbackstyle_api
Implementation of raw protocol PCBs for low-level handling of different types of
protocols besides (or overriding) those already available in lwIP.\n @see @ref
api / Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/raw.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP Operating System abstraction / Copyright (c) 2001-2004 Swedish
Institute of Computer Science. All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se> / @defgroup
sys_layer Porting (system abstraction layer) @ingroup lwip @defgroup sys_os OS
abstraction layer @ingroup sys_layer No need to implement functions in this
section in NO_SYS mode. The OS-specific code should be implemented in
arch/sys_arch.h and sys_arch.c of your port. The operating system emulation
layer provides a common interface between the lwIP code and the underlying
operating system kernel. The general idea is that porting lwIP to new
architectures requires only small changes to a few header files and a new
sys_arch implementation. It is also possible to do a sys_arch implementation
that does not rely on any underlying operating system. The sys_arch provides
semaphores, mailboxes and mutexes to lwIP. For the full lwIP functionality,
multiple threads support can be implemented in the sys_arch, but this is not
required for the basic lwIP functionality. Timer scheduling is implemented in
lwIP, but can be implemented by the sys_arch port (LWIP_TIMERS_CUSTOM1). In
addition to the source file providing the functionality of sys_arch, the OS
emulation layer must provide several header files defining macros used
throughout lwip. The files required and the macros they must define are listed
below the sys_arch description. Since lwIP 1.4.0, semaphore, mutexes and mailbox
functions are prototyped in a way that allows both using pointers or actual OS
structures to be used. This way, memory required for such types can be either
allocated in place (globally or on the stack) or on the heap (allocated
internally in the "_new()" functions). Note: Be careful with using mem_malloc()
in sys_arch. When malloc() refers to mem_malloc() you can run into a circular
function call problem. In mem.c mem_init() tries to allocate a semaphore using
mem_malloc, which of course can't be performed when sys_arch uses mem_malloc.
@defgroup sys_sem Semaphores @ingroup sys_os Semaphores can be either counting
or binary - lwIP works with both kinds. Semaphores are represented by the type
"sys_sem_t" which is typedef'd in the sys_arch.h file. Mailboxes are
equivalently represented by the type "sys_mbox_t". Mutexes are represented by
the type "sys_mutex_t". lwIP does not place any restrictions on how these types
are represented internally. @defgroup sys_mutex Mutexes @ingroup sys_os Mutexes
are recommended to correctly handle priority inversion, especially if you use
LWIP_CORE_LOCKING . @defgroup sys_mbox Mailboxes @ingroup sys_os Mailboxes
should be implemented as a queue which allows multiple messages to be posted
(implementing as a rendez-vous point where only one message can be posted at a
time can have a highly negative impact on performance). A message in a mailbox
is just a pointer, nothing more. @defgroup sys_time Time @ingroup sys_layer
@defgroup sys_prot Critical sections @ingroup sys_layer Used to protect short
regions of code against concurrent access. - Your system is a bare-metal system
(probably with an RTOS) and interrupts are under your control: Implement this as
LockInterrupts() / UnlockInterrupts() - Your system uses an RTOS with deferred
interrupt handling from a worker thread: Implement as a global mutex or
lock/unlock scheduler - Your system uses a high-level OS with e.g. POSIX
signals: Implement as a global mutex @defgroup sys_misc Misc @ingroup sys_os /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/sys.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Transmission Control Protocol for IP See also @ref tcp_raw @defgroup
tcp_raw TCP @ingroup callbackstyle_api Transmission Control Protocol for IP\n
@see @ref api Common functions for the TCP implementation, such as functions for
manipulating the data structures and the TCP timer functions. TCP functions
related to input and output is found in tcp_in.c and tcp_out.c respectively.\n
TCP connection setup The functions used for setting up connections is similar to
that of the sequential API and of the BSD socket API. A new TCP connection
identifier (i.e., a protocol control block - PCB) is created with the tcp_new()
function. This PCB can then be either set to listen for new incoming connections
or be explicitly connected to another host. - tcp_new() - tcp_bind() -
tcp_listen() and tcp_listen_with_backlog() - tcp_accept() - tcp_connect()
Sending TCP data TCP data is sent by enqueueing the data with a call to
tcp_write() and triggering to send by calling tcp_output(). When the data is
successfully transmitted to the remote host, the application will be notified
with a call to a specified callback function. - tcp_write() - tcp_output() -
tcp_sent() Receiving TCP data TCP data reception is callback based - an
application specified callback function is called when new data arrives. When
the application has taken the data, it has to call the tcp_recved() function to
indicate that TCP can advertise increase the receive window. - tcp_recv() -
tcp_recved() Application polling When a connection is idle (i.e., no data is
either transmitted or received), lwIP will repeatedly poll the application by
calling a specified callback function. This can be used either as a watchdog
timer for killing connections that have stayed idle for too long, or as a method
of waiting for memory to become available. For instance, if a call to
tcp_write() has failed because memory wasn't available, the application may use
the polling functionality to call tcp_write() again when the connection has been
idle for a while. - tcp_poll() Closing and aborting connections - tcp_close() -
tcp_abort() - tcp_err() / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/tcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Transmission Control Protocol, outgoing traffic The output functions of
TCP. There are two distinct ways for TCP segments to get sent: - queued data:
these are segments transferring data or segments containing SYN or FIN (which
both count as one sequence number). They are created as struct @ref pbuf
together with a struct tcp_seg and enqueue to the unsent list of the pcb. They
are sent by tcp_output: - @ref tcp_write : creates data segments - @ref
tcp_split_unsent_seg : splits a data segment - @ref tcp_enqueue_flags : creates
SYN-only or FIN-only segments - @ref tcp_output / tcp_output_segment : finalize
the tcp header (e.g. sequence numbers, options, checksum) and output to IP - the
various tcp_rexmit functions shuffle around segments between the unsent an
unacked lists to retransmit them - tcp_create_segment and tcp_pbuf_prealloc
allocate pbuf and segment for these functions - direct send: these segments
don't contain data but control the connection behaviour. They are created as
pbuf only and sent directly without enqueueing them: - @ref tcp_send_empty_ack
sends an ACK-only segment - @ref tcp_rst sends a RST segment - @ref
tcp_keepalive sends a keepalive segment - @ref tcp_zero_window_probe sends a
window probe segment - tcp_output_alloc_header allocates a header-only pbuf for
these functions / Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/tcp_out.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file User Datagram Protocol module\n The code for the User Datagram Protocol
UDP & UDPLite (RFC 3828).\n See also @ref udp_raw @defgroup udp_raw UDP @ingroup
callbackstyle_api User Datagram Protocol module\n @see @ref api / Copyright (c)
2001-2004 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels <adam@sics.se>
/ @todo Check the use of '(struct udp_pcb).chksum_len_rx'! /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/udp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Dynamic Host Configuration Protocol client @defgroup dhcp4 DHCPv4 @ingroup
ip4 DHCP (IPv4) related functions This is a DHCP client for the lwIP TCP/IP
stack. It aims to conform with RFC 2131 and RFC 2132. @todo: - Support for
interfaces other than Ethernet (SLIP, PPP, ...) Options: @ref
DHCP_COARSE_TIMER_SECS (recommended 60 which is a minute) @ref
DHCP_FINE_TIMER_MSECS (recommended 500 which equals TCP coarse timer)
dhcp_start() starts a DHCP client instance which configures the interface by
obtaining an IP address lease and maintaining it. Use dhcp_release() to end the
lease and use dhcp_stop() to remove the DHCP client. @see
LWIP_HOOK_DHCP_APPEND_OPTIONS @see LWIP_HOOK_DHCP_PARSE_OPTION @see
netifapi_dhcp4 / Copyright (c) 2001-2004 Leon Woestenberg
<leon.woestenberg@gmx.net> Copyright (c) 2001-2004 Axon Digital Design B.V., The
Netherlands. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. The Swedish Institute of Computer Science and Adam Dunkels are
specifically granted permission to redistribute this source code. Author: Leon
Woestenberg <leon.woestenberg@gmx.net> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/dhcp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Address Resolution Protocol module for IP over Ethernet Functionally, ARP
is divided into two parts. The first maps an IP address to a physical address
when sending a packet, and the second part answers requests from other machines
for our physical address. This implementation complies with RFC 826 (Ethernet
ARP). It supports Gratuitous ARP from RFC3220 (IP Mobility Support for IPv4)
section 4.6 if an interface calls etharp_gratuitous(our_netif) upon address
change. / Copyright (c) 2001-2003 Swedish Institute of Computer Science.
Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv> Copyright
(c) 2003-2004 Axon Digital Design B.V., The Netherlands. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv4/etharp.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file @defgroup dhcp6 DHCPv6 @ingroup ip6 DHCPv6 client: IPv6 address
autoconfiguration as per RFC 3315 (stateful DHCPv6) and RFC 3736 (stateless
DHCPv6). For now, only stateless DHCPv6 is implemented! TODO: - enable/disable
API to not always start when RA is received - stateful DHCPv6 (for now, only
stateless DHCPv6 for DNS and NTP servers works) - create Client Identifier? -
only start requests if a valid local address is available on the netif - only
start information requests if required (not for every RA)
dhcp6_enable_stateful() enables stateful DHCPv6 for a netif (stateless
disabled)\n dhcp6_enable_stateless() enables stateless DHCPv6 for a netif
(stateful disabled)\n dhcp6_disable() disable DHCPv6 for a netif When enabled,
requests are only issued after receipt of RA with the corresponding bits set. /
Copyright (c) 2018 Simon Goldschmidt All rights reserved. Redistribution and use
in source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/dhcp6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Multicast listener discovery @defgroup mld6 MLD6 @ingroup ip6 Multicast
listener discovery for IPv6. Aims to be compliant with RFC 2710. No support for
MLDv2.\n Note: The allnodes (ff01::1, ff02::1) group is assumed be received by
your netif since it must always be received for correct IPv6 operation (e.g.
SLAAC). Ensure the netif filters are configured accordingly!\n The netif flags
also need NETIF_FLAG_MLD6 flag set to enable MLD6 on a netif ("netif->flags |
NETIF_FLAG_MLD6;").\n To be called from TCPIP thread. / Copyright (c) 2010 Inico
Technologies Ltd. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> / Based on igmp.c
implementation of igmp v2 protocol /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/core/ipv6/mld6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file This file is a posix wrapper for lwip/if_api.h. / Copyright (c) 2017 Joel
Cunningham, Garmin International, Inc. <joel.cunningham@garmin.com> All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/compat/posix/net/if.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

@file This file is a posix/stdc wrapper for lwip/errno.h. / Redistribution and
use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/compat/stdc/errno.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP connection API (to be used from TCPIP thread)\n
This file contains the generic API. For more details see @ref altcp_api. /
Copyright (c) 2017 Simon Goldschmidt All rights reserved. Redistribution and use
in source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/altcp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP/TLS connection API (to be used from TCPIP thread)
@defgroup altcp_tls TLS layer @ingroup altcp This file contains function
prototypes for a TLS layer. A port to ARM mbedtls is provided in the apps/ tree
(LWIP_ALTCP_TLS_MBEDTLS option). / Copyright (c) 2017 Simon Goldschmidt All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/altcp_tls.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file various utility macros / Copyright (c) 2001-2004 Swedish Institute of
Computer Science. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Adam Dunkels <adam@sics.se> / @defgroup perf Performance
measurement @ingroup sys_layer All defines related to this section must not be
placed in lwipopts.h, but in arch/perf.h! Measurement calls made throughout
lwip, these can be defined to nothing. - PERF_START: start measuring something.
- PERF_STOP(x): stop measuring something, and record the result. /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/def.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DHCPv6 client: IPv6 address autoconfiguration as per RFC 3315 (stateful
DHCPv6) and RFC 3736 (stateless DHCPv6). / Copyright (c) 2018 Simon Goldschmidt
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/dhcp6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Interface Identification APIs from: RFC 3493: Basic Socket Interface
Extensions for IPv6 Section 4: Interface Identification / Copyright (c) 2017
Joel Cunningham, Garmin International, Inc. <joel.cunningham@garmin.com> All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Joel Cunningham <joel.cunningham@me.com> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/if_api.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IPv6 address scopes, zones, and scoping policy. This header provides the
means to implement support for IPv6 address scopes, as per RFC 4007. An address
scope can be either global or more constrained. In lwIP, we say that an address
"has a scope" or "is scoped" when its scope is constrained, in which case the
address is meaningful only in a specific "zone." For unicast addresses, only
link-local addresses have a scope; in that case, the scope is the link. For
multicast addresses, there are various scopes defined by RFC 4007 and others.
For any constrained scope, a system must establish a (potentially one-to-many)
mapping between zones and local interfaces. For example, a link-local address is
valid on only one link (its zone). That link may be attached to one or more
local interfaces. The decisions on which scopes are constrained and the mapping
between zones and interfaces is together what we refer to as the "scoping
policy" - more on this in a bit. In lwIP, each IPv6 address has an associated
zone index. This zone index may be set to "no zone" (IP6_NO_ZONE, 0) or an
actual zone. We say that an address "has a zone" or "is zoned" when its zone
index is not set to "no zone." In lwIP, in principle, each address should be
"properly zoned," which means that if the address has a zone if and only if has
a scope. As such, it is a rule that an unscoped (e.g., global) address must
never have a zone. Even though one could argue that there is always one zone
even for global scopes, this rule exists for implementation simplicity.
Violation of the rule will trigger assertions or otherwise result in undesired
behavior. Backward compatibility prevents us from requiring that applications
always provide properly zoned addresses. We do enforce the rule that the in the
lwIP link layer (everything below netif->output_ip6() and in particular ND6) all
addresses are properly zoned. Thus, on the output paths down the stack, various
places deal with the case of addresses that lack a zone. Some of them are best-
effort for efficiency (e.g. the PCB bind and connect API calls' attempts to add
missing zones); ultimately the IPv6 output handler (@ref ip6_output_if_src) will
set a zone if necessary. Aside from dealing with scoped addresses lacking a
zone, a proper IPv6 implementation must also ensure that a packet with a scoped
source and/or destination address does not leave its zone. This is currently
implemented in the input and forward functions. However, for output, these
checks are deliberately omitted in order to keep the implementation lightweight.
The routing algorithm in @ref ip6_route will take decisions such that it will
not cause zone violations unless the application sets bad addresses, though. In
terms of scoping policy, lwIP implements the default policy from RFC 4007 using
macros in this file. This policy considers link-local unicast addresses and
(only) interface-local and link-local multicast addresses as having a scope. For
all these addresses, the zone is equal to the interface. As shown below in this
file, it is possible to implement a custom policy. / Copyright (c) 2017 The
MINIX 3 Project. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: David van Moolenbroek <david@minix3.org> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/ip6_zone.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Base TCP API definitions shared by TCP and ALTCP\n See also @ref tcp_raw /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/tcpbase.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP/TLS connection API (to be used from TCPIP thread)
This file contains options for an mbedtls port of the TLS layer. / Copyright (c)
2017 Simon Goldschmidt All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/altcp_tls_mbedtls_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file HTTP client / Copyright (c) 2018 Simon Goldschmidt <goldsimon@gmx.de> All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/http_client.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file MQTT client (private interface) / Copyright (c) 2016 Erik Andersson All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Erik Andersson /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/apps/mqtt_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Application layered TCP connection API (to be used from TCPIP thread)\n
This interface mimics the tcp callback API to the application while preventing
direct linking (much like virtual functions). This way, an application can make
use of other application layer protocols on top of TCP without knowing the
details (e.g. TLS, proxy connection). / Copyright (c) 2017 Simon Goldschmidt All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/altcp_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP internal memory implementations (do not use in application code) /
Copyright (c) 2018 Swedish Institute of Computer Science. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Simon Goldschmidt
<goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/mem_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file raw API internal implementations (do not use in application code) /
Copyright (c) 2001-2004 Swedish Institute of Computer Science. All rights
reserved. Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. 2. Redistributions in binary form
must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with
the distribution. 3. The name of the author may not be used to endorse or
promote products derived from this software without specific prior written
permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. This file is part of the lwIP TCP/IP stack. Author: Adam Dunkels
<adam@sics.se> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/raw_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Sockets API internal implementations (do not use in application code) /
Copyright (c) 2017 Joel Cunningham, Garmin International, Inc.
<joel.cunningham@garmin.com> All rights reserved. Redistribution and use in
source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Joel Cunningham <joel.cunningham@me.com> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/priv/sockets_priv.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file DHCPv6 protocol definitions / Copyright (c) 2017 Simon Goldschmidt
<goldsimon@gmx.de> All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/dhcp6.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IANA assigned numbers (RFC 1700 and successors) @defgroup iana IANA
assigned numbers @ingroup infrastructure / Copyright (c) 2017 Dirk Ziegelmeier.
All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Dirk Ziegelmeier <dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/iana.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file IEEE assigned numbers @defgroup ieee IEEE assigned numbers @ingroup
infrastructure / Copyright (c) 2017 Dirk Ziegelmeier. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met: 1. Redistributions
of source code must retain the above copyright notice, this list of conditions
and the following disclaimer. 2. Redistributions in binary form must reproduce
the above copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the distribution. 3.
The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission. THIS SOFTWARE IS
PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file is part of the lwIP TCP/IP stack. Author: Dirk Ziegelmeier
<dziegel@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/lwip/prot/ieee.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP netif implementing an IEEE 802.1D MAC Bridge / Copyright (c) 2017
Simon Goldschmidt. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/bridgeif.h
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/bridgeif_opts.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Definitions for IEEE 802.15.4 MAC frames / Copyright (c) 2018 Simon
Goldschmidt. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/ieee802154.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file 6LowPAN over BLE for IPv6 (RFC7668). / Copyright (c) 2017 Benjamin Aigner
Copyright (c) 2015 Inico Technologies Ltd. , Author: Ivan Delamer
<delamer@inicotech.com> All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Benjamin Aigner <aignerb
@technikum-wien.at> Based on the original 6lowpan implementation of lwIP ( @see
6lowpan.c) /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/lowpan6_ble.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Common 6LowPAN routines for IPv6. Uses ND tables for link-layer
addressing. Fragments packets to 6LowPAN units. / Copyright (c) 2015 Inico
Technologies Ltd. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/lowpan6_common.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file A netif implementing the ZigBee Eencapsulation Protocol (ZEP). This is
used to tunnel 6LowPAN over UDP. / Copyright (c) 2018 Simon Goldschmidt All
rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/include/netif/zepif.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP netif implementing an IEEE 802.1D MAC Bridge / Copyright (c) 2017
Simon Goldschmidt. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> / @defgroup bridgeif IEEE
802.1D bridge @ingroup netifs This file implements an IEEE 802.1D bridge by
using a multilayer netif approach (one hardware-independent netif for the bridge
that uses hardware netifs for its ports). On transmit, the bridge selects the
outgoing port(s). On receive, the port netif calls into the bridge (via its
netif->input function) and the bridge selects the port(s) (and/or its
netif->input function) to pass the received pbuf to. Usage: - add the port
netifs just like you would when using them as dedicated netif without a bridge -
only NETIF_FLAG_ETHARP/NETIF_FLAG_ETHERNET netifs are supported as bridge ports
- add the bridge port netifs without IPv4 addresses (i.e. pass 'NULL, NULL,
NULL') - don't add IPv6 addresses to the port netifs! - set up the bridge
configuration in a global variable of type 'bridgeif_initdata_t' that contains -
the MAC address of the bridge - some configuration options controlling the
memory consumption (maximum number of ports and FDB entries) - e.g. for a bridge
MAC address 00-01-02-03-04-05, 2 bridge ports, 1024 FDB entries + 16 static MAC
entries: bridgeif_initdata_t mybridge_initdata BRIDGEIF_INITDATA1(2, 1024, 16,
ETH_ADDR(0, 1, 2, 3, 4, 5)); - add the bridge netif (with IPv4 config): struct
netif bridge_netif; netif_add(&bridge_netif, &my_ip, &my_netmask, &my_gw,
&mybridge_initdata, bridgeif_init, tcpip_input); NOTE: the passed 'input'
function depends on BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT setting, which controls
where the forwarding is done (netif low level input context vs. tcpip_thread) -
set up all ports netifs and the bridge netif - When adding a port netif,
NETIF_FLAG_ETHARP flag will be removed from a port to prevent ETHARP working on
that port netif (we only want one IP per bridge not per port). - When adding a
port netif, its input function is changed to call into the bridge. @todo: -
compact static FDB entries (instead of walking the whole array) - add FDB
query/read access - add FDB change callback (when learning or dropping auto-
learned entries) - prefill FDB with MAC classes that should never be forwarded -
multicast snooping? (and only forward group addresses to interested ports) -
support removing ports - check SNMP integration - VLAN handling / trunk ports -
priority handling? (although that largely depends on TX queue limitations and
lwIP doesn't provide tx-done handling) /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/bridgeif.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file lwIP netif implementing an FDB for IEEE 802.1D MAC Bridge / Copyright (c)
2017 Simon Goldschmidt. All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> / @defgroup bridgeif_fdb FDB
example code @ingroup bridgeif This file implements an example for an FDB
(Forwarding DataBase) /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/bridgeif_fdb.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file 6LowPAN output for IPv6. Uses ND tables for link-layer addressing.
Fragments packets to 6LowPAN units. This implementation aims to conform to IEEE
802.15.4(-2015), RFC 4944 and RFC 6282. @todo: RFC 6775. / Copyright (c) 2015
Inico Technologies Ltd. All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Ivan Delamer <delamer@inicotech.com> Please coordinate changes
and requests with Ivan Delamer <delamer@inicotech.com> / @defgroup sixlowpan
6LoWPAN (RFC4944) @ingroup netifs 6LowPAN netif implementation /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/lowpan6.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file 6LowPAN over BLE output for IPv6 (RFC7668). Copyright (c) 2017 Benjamin
Aigner Copyright (c) 2015 Inico Technologies Ltd. , Author: Ivan Delamer
<delamer@inicotech.com> All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Author: Benjamin Aigner <aignerb
@technikum-wien.at> Based on the original 6lowpan implementation of lwIP ( @see
6lowpan.c) / @defgroup rfc7668if 6LoWPAN over BLE (RFC7668) @ingroup netifs This
file implements a RFC7668 implementation for 6LoWPAN over Bluetooth Low Energy.
The specification is very similar to 6LoWPAN, so most of the code is re-used.
Compared to 6LoWPAN, much functionality is already implemented in lower BLE
layers (fragmenting, session management,...). Usage: - add this netif - don't
add IPv4 addresses (no IPv4 support in RFC7668), pass 'NULL','NULL','NULL' - use
the BLE to EUI64 conversation util to create an IPv6 link-local address from the
BLE MAC (@ref ble_addr_to_eui64) - input function: @ref rfc7668_input - set the
link output function, which transmits output data to an established L2CAP
channel - If data arrives (HCI event "L2CAP_DATA_PACKET"): - allocate a @ref
PBUF_RAW buffer - let the pbuf struct point to the incoming data or copy it to
the buffer - call netif->input @todo: - further testing - support compression
contexts - support multiple addresses - support multicast - support neighbor
discovery /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/lowpan6_ble.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file Common 6LowPAN routines for IPv6. Uses ND tables for link-layer
addressing. Fragments packets to 6LowPAN units. This implementation aims to
conform to IEEE 802.15.4(-2015), RFC 4944 and RFC 6282. @todo: RFC 6775. /
Copyright (c) 2015 Inico Technologies Ltd. All rights reserved. Redistribution
and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the
following disclaimer. 2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part
of the lwIP TCP/IP stack. Author: Ivan Delamer <delamer@inicotech.com> Please
coordinate changes and requests with Ivan Delamer <delamer@inicotech.com> /
@defgroup sixlowpan 6LoWPAN (RFC4944) @ingroup netifs 6LowPAN netif
implementation /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/lowpan6_common.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file SLIP Interface / Copyright (c) 2001-2004 Swedish Institute of Computer
Science. All rights reserved. Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. Neither the name of the
Institute nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is built
upon the file: src/arch/rtxc/netif/sioslip.c Author: Magnus Ivarsson
<magnus.ivarsson(at)volvo.com> Simon Goldschmidt / @defgroup slipif SLIP
@ingroup netifs This is an arch independent SLIP netif. The specific serial
hooks must be provided by another file. They are sio_open, sio_read/sio_tryread
and sio_send Usage: This netif can be used in three ways:\n 1) For NO_SYS0, an
RX thread can be used which blocks on sio_read() until data is received.\n 2) In
your main loop, call slipif_poll() to check for new RX bytes, completed packets
are fed into netif->input().\n 3) Call slipif_received_byte[s]() from your
serial RX ISR and slipif_process_rxqueue() from your main loop. ISR level
decodes packets and puts completed packets on a queue which is fed into the
stack from the main loop (needs SYS_LIGHTWEIGHT_PROT for pbuf_alloc to work on
ISR level!). /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/slipif.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

@file @defgroup zepif ZEP - ZigBee Encapsulation Protocol @ingroup netifs A
netif implementing the ZigBee Encapsulation Protocol (ZEP). This is used to
tunnel 6LowPAN over UDP. Usage (there must be a default netif before!):
@code{.c} netif_add(&zep_netif, NULL, NULL, NULL, NULL, zepif_init,
tcpip_6lowpan_input); netif_create_ip6_linklocal_address(&zep_netif, 1);
netif_set_up(&zep_netif); netif_set_link_up(&zep_netif); @endcode / Copyright
(c) 2018 Simon Goldschmidt All rights reserved. Redistribution and use in source
and binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name of the author may
not be used to endorse or promote products derived from this software without
specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This file is part of the lwIP TCP/IP
stack. Author: Simon Goldschmidt <goldsimon@gmx.de> /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/zepif.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

chap_ms.c - Microsoft MS-CHAP compatible implementation. Copyright (c) 1995 Eric
Rosenquist. All rights reserved. Redistribution and use in source and binary
forms, with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name(s) of the authors of
this software must not be used to endorse or promote products derived from this
software without prior written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM
ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. / Modifications by Lauri Pesonen /
lpesonen@clinet.fi, april 1997 Implemented LANManager type password response to
MS-CHAP challenges. Now pppd provides both NT style and LANMan style blocks, and
the preferred is set by option "ms-lanman". Default is to use NT. The hash text
(StdText) was taken from Win95 RASAPI32.DLL. You should also use
DOMAIN\\USERNAME as described in README.MSCHAP80 / Modifications by Frank
Cusack, frank@google.com, March 2002. Implemented MS-CHAPv2 functionality,
heavily based on sample implementation in RFC 2759. Implemented MPPE
functionality, heavily based on sample implementation in RFC 3079. Copyright (c)
2002 Google, Inc. All rights reserved. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
above copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. The name(s) of the authors of
this software must not be used to endorse or promote products derived from this
software without prior written permission. THE AUTHORS OF THIS SOFTWARE DISCLAIM
ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE. /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/chap_ms.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

ppp.c - Network Point to Point Protocol program file. Copyright (c) 2003 by Marc
Boucher, Services Informatiques (MBSI) inc. portions Copyright (c) 1997 by
Global Election Systems Inc. The authors hereby grant permission to use, copy,
modify, distribute, and license this software and its documentation for any
purpose, provided that existing copyright notices are retained in all copies and
that this notice and the following disclaimer are included verbatim in any
distributions. No written agreement, license, or royalty fee is required for any
of the authorized uses. THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS AS IS AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. REVISION HISTORY 03-01-01 Marc
Boucher <marc@mbsi.ca> Ported to lwIP. 97-11-05 Guy Lancaster
<lancasterg@acm.org>, Global Election Systems Inc. Original. ppp_defs.h - PPP
definitions. if_pppvar.h - private structures and declarations for PPP.
Copyright (c) 1994 The Australian National University. All rights reserved.
Permission to use, copy, modify, and distribute this software and its
documentation is hereby granted, provided that the above copyright notice
appears in all copies. This software is provided without any warranty, express
or implied. The Australian National University makes no representations about
the suitability of this software for any purpose. IN NO EVENT SHALL THE
AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS
SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUSTRALIAN NATIONAL UNIVERSITY HAVE
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE AUSTRALIAN NATIONAL
UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE AUSTRALIAN
NATIONAL UNIVERSITY HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS. / if_ppp.h - Point-to-Point Protocol
definitions. Copyright (c) 1989 Carnegie Mellon University. All rights reserved.
Redistribution and use in source and binary forms are permitted provided that
the above copyright notice and this paragraph are duplicated in all such forms
and that any documentation, advertising materials, and other materials related
to such distribution and use acknowledge that the software was developed by
Carnegie Mellon University. The name of the University may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. / @defgroup ppp PPP
@ingroup netifs @verbinclude "ppp.txt" /

FILES:
ThirdParty/sw_services/lwip211/src/lwip-2.1.1/src/netif/ppp/ppp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 pkp 12/03/15 Initial Release 1.00 srm 02/21/18
Updated freertos to 10.0 version

FILES:
ThirdParty/sw_services/openamp/data/openamp.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 pkp 12/03/15 Initial Release openamp_drc

FILES:
ThirdParty/sw_services/openamp/data/openamp.tcl
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. SPDX-
License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/elf_loader.h
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/open_amp.h
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/rsc_table_parser.h
ThirdParty/sw_services/openamp/src/open-amp/lib/remoteproc/elf_loader.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [Google]

COPYRIGHT TEXT:
---------------

Remoteproc Framework Copyright(c) 2018 Xilinx Ltd. Copyright(c) 2011 Texas
Instruments, Inc. Copyright(c) 2011 Google, Inc. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/remoteproc.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / FILE NAME remoteproc_loader.h COMPONENT
OpenAMP stack. DESCRIPTION This file provides definitions for remoteproc loader
/

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/remoteproc_loader.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [Google]

COPYRIGHT TEXT:
---------------

Remoteproc Virtio Framework Copyright(c) 2018 Xilinx Ltd. Copyright(c) 2011
Texas Instruments, Inc. Copyright(c) 2011 Google, Inc. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/remoteproc_virtio.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [Google]

COPYRIGHT TEXT:
---------------

Remote processor messaging Copyright (C) 2011 Texas Instruments, Inc. Copyright
(C) 2011 Google, Inc. All rights reserved. Copyright (c) 2016 Freescale
Semiconductor, Inc. All rights reserved. SPDX-License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/rpmsg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

rpmsg based on virtio Copyright (C) 2018 Linaro, Inc. All rights reserved.
Copyright (c) 2016 Freescale Semiconductor, Inc. All rights reserved. SPDX-
License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/rpmsg_virtio.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright Rusty Russell IBM Corporation 2007. SPDX-License-Identifier:
BSD-3-Clause $FreeBSD$ /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/include/openamp/virtio_ring.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. All rights
reserved. SPDX-License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/remoteproc/remoteproc.c
lib/sw_apps/openamp_echo_test/src/system/freertos/machine/zynq7/helper.c
lib/sw_apps/openamp_echo_test/src/system/freertos/machine/zynqmp_r5/helper.c
lib/sw_apps/openamp_echo_test/src/system/generic/machine/zynq7/helper.c
lib/sw_apps/openamp_echo_test/src/system/generic/machine/zynqmp_r5/helper.c
lib/sw_apps/openamp_matrix_multiply/src/system/freertos/machine/zynq7/helper.c
lib/sw_apps/openamp_matrix_multiply/src/system/freertos/machine/zynqmp_r5/helper.c
lib/sw_apps/openamp_matrix_multiply/src/system/generic/machine/zynq7/helper.c
lib/sw_apps/openamp_matrix_multiply/src/system/generic/machine/zynqmp_r5/helper.c
lib/sw_apps/openamp_rpc_demo/src/system/freertos/machine/zynq7/helper.c
lib/sw_apps/openamp_rpc_demo/src/system/freertos/machine/zynqmp_r5/helper.c
lib/sw_apps/openamp_rpc_demo/src/system/generic/machine/zynq7/helper.c
lib/sw_apps/openamp_rpc_demo/src/system/generic/machine/zynqmp_r5/helper.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [Google]

COPYRIGHT TEXT:
---------------

Remoteproc Virtio Framework Implementation Copyright(c) 2018 Xilinx Ltd.
Copyright(c) 2011 Texas Instruments, Inc. Copyright(c) 2011 Google, Inc. All
rights reserved. SPDX-License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/remoteproc/remoteproc_virtio.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation Copyright (c) 2018, Xilinx Inc.
All rights reserved. SPDX-License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/remoteproc/rsc_table_parser.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. Copyright
(c) 2016 Freescale Semiconductor, Inc. All rights reserved. Copyright (c) 2018
Linaro, Inc. All rights reserved. SPDX-License-Identifier: BSD-3-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/rpmsg/rpmsg.c
ThirdParty/sw_services/openamp/src/open-amp/lib/rpmsg/rpmsg_virtio.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2011, Bryan Venteicher <bryanv@FreeBSD.org> All rights reserved.
SPDX-License-Identifier: BSD-2-Clause /

FILES:
ThirdParty/sw_services/openamp/src/open-amp/lib/virtio/virtio.c
ThirdParty/sw_services/openamp/src/open-amp/lib/virtio/virtqueue.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaierts_test_app.c @{ This file
contains the bare-metal test application for AIE C RTS. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh 05/23/2018
Initial creation 1.1 Naresh 07/11/2018 Updated copyright info 1.2 Nishad
12/05/2018 Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/xaierts_test_app.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsock.c @{ This file contains
the routines for client side socket creation and management. Applicable only for
the AIE simulation environment execution on linux. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 Naresh 03/27/2018 Initial
creation 1.1 Naresh 06/13/2018 Fixed CR1003905 1.2 Naresh 07/11/2018 Updated
copyright info 1.3 Nishad 12/05/2018 Renamed ME attributes to AIE </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/sockcli/xsock.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsock.h @{ This file contains
the prototypes of the variables and functions for the client socket creation and
management. Applicable only for the AIE simulation environment execution on
linux. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 Naresh 03/27/2018 Initial creation 1.1 Naresh 06/13/2018 Fixed CR1003905 1.2
Naresh 07/11/2018 Updated copyright info 1.3 Nishad 12/05/2018 Renamed ME
attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/sockcli/xsock.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsock_clitest.c @{ This file
contains the entry point for the client socket connection test and other tests
for sample startup.py <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 Naresh 04/06/2018 Initial creation 1.1 Naresh 04/10/2018
Added call to API XAieSim_Init 1.2 Naresh 04/10/2018 Added macro call for
XAIESIM_DEVCFG_SET_CONFIG 1.3 Naresh 04/18/2018 Added API call for
XAieTile_DmWriteWord 1.4 Naresh 05/23/2018 Updated code to fix CR999693 1.5
Naresh 06/13/2018 Fixed CR1003905 1.6 Naresh 07/11/2018 Updated copyright info
1.7 Nishad 12/05/2018 Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/sockcli/xsock_clitest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsock_servtest.c @{ This file
contains the entry point for the server socket connection test. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh
02/19/2018 Initial creation 1.1 Naresh 07/11/2018 Updated copyright info 1.2
Nishad 12/05/2018 Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/sockserv/xsock_servtest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiesim.c @{ This file contains
the low level layer interface to the AIE simulator. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 Naresh 04/06/2018 Initial
creation 1.1 Naresh 04/10/2018 Added the API XAieSim_Init 1.2 Naresh 04/18/2018
Modified workaround for CRVO1696/CR999680 to extend it to all types of registers
and also for all the tiles i.e., not just specific to PL interface regs 1.3
Naresh 05/07/2018 Fixed CR1001816 1.4 Naresh 05/23/2018 Updated code to fix
CR999693 and removed the static data structure allocation for the registers to
be monitored, instead added dynamic memory allocation. 1.5 Naresh 06/13/2018
Fixed CR1003905, CR1004494 1.6 Naresh 07/11/2018 Updated copyright info 1.7 Hyun
10/16/2018 Added XAieSim_IO_Funcs to support dynamic backend select at runtime
as a part of CDO generation support. CR-1012480 1.8 Nishad 12/05/2018 Renamed ME
attributes to AIE 1.9 Hyun 01/08/2018 Add the MaskPoll 2.0 Hyun 04/05/2018 NPI
support </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/top/xaiesim.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiesim.h @{ This file contains
the generic definitions for the AIE simulator interface. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh 04/06/2018
Initial creation 1.1 Naresh 04/10/2018 Added the API declaration for
XAieSim_Init 1.2 Naresh 04/10/2018 Added macro XAIESIM_DEVCFG_SET_CONFIG 1.3
Naresh 04/18/2018 Modified workaround for CRVO1696/CR999680 to extend it to all
types of registers and also for all tiles 1.4 Naresh 05/07/2018 Fixed CR1001816
1.5 Naresh 05/23/2018 Updated code to fix CR999693 1.6 Naresh 07/11/2018 Updated
copyright info 1.7 Hyun 09/12/2018 Fixed CR1006669 1.8 Hyun 10/16/2018 Added
XAieSim_SetIOMode and mask write APIs 1.9 Nishad 12/05/2018 Renamed ME
attributes to AIE 2.0 Hyun 01/08/2018 Add the MaskPoll 2.1 Hyun 04/05/2018 NPI
support </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/top/xaiesim.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiesim_elfload.c @{ This file
contains the API for ELF loading. Applicable only for the AIE simulation
environment execution on linux. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Naresh 04/06/2018 Initial creation 1.1 Naresh
05/07/2018 Fixed CR1001944, CR1002101 1.2 Naresh 06/13/2018 Fixed CR1003905 1.3
Naresh 07/11/2018 Updated copyright info 1.4 Naresh 07/26/2018 Fixed CR1007367
1.5 Hyun 08/27/2018 Fixed the incorrect remaining bytes, CR-1009665 1.6 Nishad
12/05/2018 Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/top/xaiesim_elfload.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiesim_elfload.h @{ This file
contains the variable and function prototypes for ELF loading. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh
03/27/2018 Initial creation 1.1 Naresh 05/07/2018 Updated code to fix CR1001944
1.2 Naresh 06/13/2018 Fixed CR1003905 1.3 Naresh 07/11/2018 Updated copyright
info 1.4 Nishad 12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/examples/aie_sim_test/ext/top/xaiesim_elfload.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiedma_shim.c @{ This file
contains the routines to initialize and configure the Shim DMA. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh
03/14/2018 Initial creation 1.1 Naresh 07/11/2018 Updated copyright info 1.2
Nishad 12/05/2018 Renamed ME attributes to AIE 1.3 Hyun 01/08/2019 Use the poll
function </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/dma/xaiedma_shim.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiedma_shim.h @{ Header file
for the Shim DMA functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh
07/11/2018 Updated copyright info 1.2 Nishad 12/05/2018 Renamed ME attributes to
AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/dma/xaiedma_shim.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiedma_tile.c @{ This file
contains the routines to initialize and configure the Tile DMA. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh
04/06/2018 Initial creation 1.1 Naresh 04/12/2018 Added workaround for CRVO1692
1.2 Naresh 06/20/2018 Fixed CR1005445 1.3 Naresh 07/11/2018 Updated copyright
info 1.4 Nishad 12/05/2018 Renamed ME attributes to AIE 1.5 Hyun 01/08/2019
Don't poll the status after control change 1.6 Nishad 03/20/2019 Fix the use of
uninitialized pointer in XAieDma_TileBdSetLock function </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/dma/xaiedma_tile.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiedma_tile.h @{ Header file
for the Tile DMA functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh
06/20/2018 Fixed CR1005445 1.2 Naresh 07/11/2018 Updated copyright info 1.3
Nishad 12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/dma/xaiedma_tile.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl.c @{ This file contains
the global initialization functions for the Tile. This is applicable for both
the AIE tiles and Shim tiles. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh
04/12/2018 Code changed to fix CR999685 1.2 Naresh 05/23/2018 Updated code to
fix CR999693 1.3 Naresh 07/11/2018 Updated copyright info 1.4 Nishad 12/05/2018
Renamed ME attributes to AIE 1.5 Jubaer 05/24/2019 Add PL type on TileType
attribute </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl.h @{ @details Math
Engine (ME) Run Time Software (RTS) Driver is a congregation of software based
APIs for the PS application to configure/initialize/program the AIE array and
shim. The layered software stack of the AIE RTS driver is shown below : |
Application layer (Cardano interface/PS app call) | | | | AIE RTS driver | | | |
AIE simulator / LibMetal | The Driver APIs are typically invoked by the Cardano
tool flow as part of the PS application generation. The APIs can also be
directly invoked by the user application for performing any runtime
configuration like partial reconfiguration etc. AIE driver is partitioned into
the following sub-components : - AIE Global Driver - APIs for
device/configuration lookup, global driver instantiation and initialization and
generic APIs commonly used by other components - AIE Tile Driver - APIs for
configuring the Tile resources: Core, Program memory, Data memory, Locks, Stream
switch, Events - APIs for configuring the Shim resources: NoC and PL interfaces,
Stream switch, Events - AIE DMA Driver - APIs for configuring the Tile DMA S2MM
and MM2S channels - APIs for configuring Shim DMA S2MM,MM2S channels and Locks -
AIE low level library layer - APIs to interface with the underlying target
platform AIE driver will be common for all the Math Engine devices. So in the
similar lines of xparameters.h for other standalone drivers, AIE driver also
needs the following device related parameters : - AIE Array base address -
Number of Rows - Number of Columns - Interrupt IDs These parameters can be
passed to the AIE driver in the similar lines of any other standalone driver
i.e., in the form of compile time parameters from xparameters.h or in the form
of a runtime configuration object etc. AIE RTS driver provides a suite of APIs
to be invoked by the application layer and also a low level interface
abstraction for the driver APIs to interface with the low level target specific
APIs. These low level target APIs are in turn used to talk to the underlying
target platform with typical AXI read and write transactions. Following are the
features of the AIE RTS driver APIs : - Non re-entrant and not thread safe -
Implemented as bare-metal - Implemented as blocking calls <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh 03/14/2018
Initial creation 1.1 Naresh 04/12/2018 Code changed to fix CR999685 1.2 Naresh
05/23/2018 Updated code to fix CR999693 1.3 Naresh 06/18/2018 Updated code as
per standalone driver framework 1.4 Naresh 07/11/2018 Updated copyright info 1.5
Nishad 12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl_defs.h @{ This file
contains the generic definitions for the AIE drivers. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh 03/23/2018
Initial creation 1.1 Naresh 07/11/2018 Updated copyright info 1.2 Hyun
10/10/2018 Added the mask write API 1.3 Nishad 12/05/2018 Renamed ME attributes
to AIE 1.4 Hyun 01/08/2019 Add the mask poll function </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl_defs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl_g.c @{ This file
contains a configuration table that specifies the configuration of AIE devices
in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh 07/11/2018 Updated
copyright info 1.2 Nishad 12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl_params.h @{ This file
contains the macro definitions for the AIE registers, generated from regdb
headers. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh 07/11/2018 Updated copyright
info 1.2 Nishad 12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl_params.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl_reginit.c @{ This file
contains the instances of the register bit field definitions for the Core,
Memory, NoC and PL module registers. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh
07/11/2018 Updated copyright info 1.2 Naresh 08/13/2018 Added Done attributes to
CoreStsReg 1.3 Hyun 10/02/2018 Added performance counter registers 1.4 Hyun
10/02/2018 Added event registers 1.5 Hyun 10/03/2018 Added event port select
registers 1.6 Hyun 10/12/2018 Added the colum reset register 1.7 Nishad
12/05/2018 Renamed ME attributes to AIE 1.8 Hyun 12/13/2018 Added the core PC
event registers 1.9 Jubaer 02/26/2019 Add Group Event registers 2.0 Hyun
06/27/2019 Change CoreTimerReg to TimerReg </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl_reginit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl.h @{ Header to include
type definitions for the register bit field definitions of Core, Memory, NoC and
PL module registers. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh 07/11/2018
Updated copyright info 1.2 Naresh 08/13/2018 Added Done attributes to CoreStsReg
1.3 Hyun 10/02/2018 Added performance counter registers 1.4 Hyun 10/02/2018
Added event registers 1.5 Hyun 10/03/2018 Added event port select registers 1.6
Hyun 10/12/2018 Added the column reset register 1.7 Nishad 12/05/2018 Renamed ME
attributes to AIE 1.6 Hyun 12/13/2018 Added the core PC event registers 1.9
Jubaer 02/26/2019 Added the Group Event registers 2.0 Hyun 07/01/2019 Added
XAIETILE_TIMER_MODULE_ macros </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl_reginit.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaiegbl_sinit.c @{ This file
contains the global look up configuration function for the AIE device. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh
03/14/2018 Initial creation 1.1 Naresh 06/18/2018 Updated code to be inline with
standalone driver 1.2 Naresh 07/11/2018 Updated copyright info 1.3 Nishad
12/05/2018 Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/global/xaiegbl_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaieconfig.h @{ This file
contains the generic definitions for the AIE simulator. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh 05/30/2018
Initial creation 1.1 Naresh 07/11/2018 Updated copyright info 1.2 Nishad
12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/xaieconfig.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaielib.c @{ This file contains
the low level layer interface of the AIE driver with the definitions for the
memory write and read operations. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Naresh 03/23/2018 Initial creation 1.1 Naresh
05/23/2018 Added bare-metal BSP support 1.2 Naresh 06/18/2018 Updated code as
per standalone driver framework 1.3 Naresh 07/11/2018 Updated copyright info 1.4
Hyun 10/10/2018 Added the mask write API 1.5 Hyun 10/11/2018 Don't include the
xaieio header for sim build 1.6 Hyun 10/16/2018 Added the baremetal compile
switch everywhere it's needed 1.7 Hyun 11/14/2018 Move platform dependent code
to xaielib.c 1.8 Nishad 12/05/2018 Renamed ME attributes to AIE 1.9 Hyun
01/08/2019 Implement 128bit IO operations for baremetal 2.0 Hyun 01/08/2019 Add
XAieLib_MaskPoll() 2.1 Hyun 04/05/2019 NPI support for simulation 2.2 Nishad
05/16/2019 Fix deallocation of pointer not on heap MISRA-c mandatory violation
</pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/xaielib.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaielib.h @{ This file contains
the generic definitions for the AIE drivers. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.0 Naresh 03/27/2018 Initial creation 1.1
Naresh 05/23/2018 Added support for bare-metal BSP 1.2 Naresh 06/18/2018 Updated
code as per standalone driver framework 1.3 Naresh 07/11/2018 Updated copyright
info 1.4 Hyun 10/10/2018 Added the mask write API 1.5 Hyun 11/14/2018 Move
platform dependent code to xaielib.c 1.6 Nishad 12/05/2018 Renamed ME attributes
to AIE 1.7 Hyun 01/08/2019 Add XAieLib_MaskPoll() </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/xaielib.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaielib_npi.c @{ This file
contains routines for NPI module <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Jubaer 03/08/2019 Initial creation 1.1 Hyun
04/04/2019 Add the unlock and lock sequences </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/xaielib_npi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaielib_npi.h @{ Header files
for NPI module <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 Jubaer 03/08/2019 Initial creation 1.1 Hyun 04/04/2019 Add the
unlock and lock definitions </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/xaielib_npi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_aie.h @{ This file
contains stub xparameter definitions for ME. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.0 Naresh 03/27/2018 Initial creation 1.1
Naresh 07/11/2018 Updated copyright info 1.2 Naresh 07/26/2018 Set num instances
to 1 to avoid segmentation fault 1.3 Nishad 12/05/2018 Renamed ME attributes to
AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/xparameters_aie.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xaieio.c @{ This file contains the low level layer IO interface
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Hyun
07/12/2018 Initial creation 1.1 Hyun 10/11/2018 Initialize the IO device for mem
instance 1.2 Nishad 12/05/2018 Renamed ME attributes to AIE </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/ext/xaieio.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xaieio.h @{ This file contains the generic definitions for the
AIE simulator interface. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 Hyun 07/12/2018 Initial creation 1.1 Nishad 12/05/2018
Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/ext/xaieio.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xaietile_proc.c @{ This file contains the API for AIE tile
processor. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 Hyun 08/17/2018 Initial creation 1.1 Hyun 10/15/2018 Don't start
the remoteproc in elfloading to allow multiple elfloading. 1.2 Nishad 12/05/2018
Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/ext/xaietile_proc.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xaietile_proc.h @{ This file contains the variable and function
prototypes for ELF loading. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Hyun 08/17/2018 Initial creation 1.1 Nishad 12/05/2018
Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/lib/ext/xaietile_proc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_core.c @{ This file
contains routines for the AIE Tile core control. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.0 Naresh 03/21/2018 Initial creation
1.1 Naresh 07/11/2018 Updated copyright info and addressed CR1006573 1.2 Naresh
08/13/2018 Updated core wait done API to wait for Core_done status instead of
Core_Enable and also added an API to read core done status 1.3 Nishad 12/05/2018
Renamed ME attributes to AIE 1.4 Hyun 01/08/2019 Use the poll function 1.5
Nishad 03/20/2019 Fix return statement for XAieTile_CoreWaitCycles 1.6 Nishad
03/20/2019 Fix the usage of unintialized variable in XAieTile_CoreWaitStatus 1.7
Hyun 06/27/2019 Use TimerReg </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_core.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_core.h @{ Header file
for core control and wait functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Naresh 04/06/2018 Initial creation 1.1 Naresh
05/07/2018 Fixed CR1000933 1.2 Naresh 07/11/2018 Updated copyright info and
addressed CR1006573 1.3 Naresh 08/13/2018 Updated prototype for wait done API
and also added prototype for core read status done API 1.4 Nishad 12/05/2018
Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_core.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_event.c @{ This file
contains routines for Event handling <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Hyun 10/02/2018 Initial creation 1.1 Hyun
10/10/2018 Use the mask write API 1.2 Nishad 12/05/2018 Renamed ME attributes to
AIE 1.3 Hyun 12/13/2018 Add the core event API 1.4 Jubaer 02/14/2019 Add get
Event Broadcast API 1.5 Jubaer 02/26/2019 Add group Event API 1.6 Jubaer
03/01/2019 Add Combo Event API 1.7 Jubaer 04/17/2019 Add Stream Switch Event
Port Selection API </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_event.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_event.h @{ Header file
for Event handling <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 Hyun 10/02/2018 Initial creation 1.1 Nishad 12/05/2018 Renamed ME
attributes to AIE 1.2 Hyun 12/13/2018 Added the core PC event API 1.4 Jubaer
02/14/2019 Add Broadcast Get API 1.5 Jubaer 02/26/2019 Add group Event API 1.6
Jubaer 03/01/2019 Add Combo Event API 1.7 Jubaer 04/17/2019 Add Stream Switch
Event Port Selection API </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_event.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_lock.c @{ This file
contains routine for lock acquire and release functions. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Naresh 03/14/2018
Initial creation 1.1 Naresh 04/19/2018 Updated code to fix CR1000292 1.2 Naresh
07/11/2018 Updated copyright info 1.3 Nishad 12/05/2018 Renamed ME attributes to
AIE 1.4 Hyun 01/08/2019 Use the poll function 1.5 Nishad 03/20/2019 Fix usage of
uninitialized variable in XAieTile_LockAcquire and XAieTile_LockRelease </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_lock.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_lock.h @{ Header file
lock acquire/release functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1 Naresh
07/11/2018 Updated copyright info 1.2 Nishad 12/05/2018 Renamed ME attributes to
AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_lock.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_mem.c @{ This file
contains routines for the AIE Tile memory control. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 Naresh 04/18/2018 Initial
creation to fix CR1000217 1.1 Naresh 07/11/2018 Updated copyright info and
addressed CR1006589 1.2 Nishad 12/05/2018 Renamed ME attributes to AIE 1.3 Hyun
06/27/2019 Add XAieTile_MemReadTimer() </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_mem.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_mem.h @{ Header file
for Tile memory control functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Naresh 04/18/2018 Initial creation to fix
CR1000217 1.1 Naresh 07/11/2018 Updated copyright info and addressed CR1006589
1.2 Nishad 12/05/2018 Renamed ME attributes to AIE 1.3 Hyun 06/27/2018 Add
XAieTile_MemReadTimer() </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_mem.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xaietile_noc.c @{ This file
contains routines for NoC module <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Nishad 01/29/2019 Initial creation </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_noc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xaietile_noc.h @{ Header file
for NoC module <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 Nishad 01/29/2019 Initial creation </pre> /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_noc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_perfcnt.c @{ This file
contains routines for Performance Counter configuration. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Hyun 10/02/2018 Initial
creation 1.1 Hyun 10/10/2018 Use the mask write API 1.2 Nishad 12/05/2018
Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_perfcnt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_perfcnt.h @{ Header
file for Performance Counter control <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Hyun 10/02/2018 Initial creation 1.1 Nishad
12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_perfcnt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_pl.c @{ This file
contains APIs for PL module. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Jubaer 01/29/2019 Initial creation 1.1 Jubaer
03/07/2019 Add Shim Reset Enable 1.2 Hyun 06/27/2019 Add XAieTile_PlReadTimer()
</pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_pl.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_pl.h @{ Header file
for PL module APIs. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 Jubaer 01/29/2019 Initial creation 1.1 Jubaer 03/07/2019 Add
Shim reset API 1.2 Hyun 06/27/2019 Add XAieTile_PlReadTimer() </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_pl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_plif.c @{ This file
contains routines for PL interface configuration. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 Naresh 03/14/2018 Initial
creation 1.1 Naresh 07/11/2018 Updated copyright info 1.2 Hyun 10/10/2018 Use
the mask write API 1.3 Nishad 12/05/2018 Renamed ME attributes to AIE 1.4 Jubaer
03/07/2019 Add PL if downsizer disable API </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_plif.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_plif.h @{ Header file
for PL interface configuration functions. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1
Naresh 07/11/2018 Updated copyright info 1.2 Nishad 12/05/2018 Renamed ME
attributes to AIE 1.3 Jubaer 03/07/2019 Add pl if downsizer disable API </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_plif.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_shim.c @{ This file
contains routines for Shim tile <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 Hyun 10/12/2018 Initial creation 1.1 Nishad 12/05/2018
Renamed ME attributes to AIE </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_shim.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_shim.h @{ Header file
for Shime tile <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 Hyun 10/12/2018 Initial creation 1.1 Nishad 12/05/2018 Renamed ME
attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_shim.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_strm.c @{ This file
contains routines for the Stream switch master and slave ports. These are
applicable for both the AIE and Shim tiles. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.0 Naresh 03/14/2018 Initial creation 1.1
Naresh 07/11/2018 Updated copyright info 1.2 Hyun 10/03/2018 Added the event
port select function 1.3 Hyun 10/10/2018 Use the mask write API 1.4 Nishad
12/05/2018 Renamed ME attributes to AIE </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_strm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaietile_strm.h @{ Header file
for stream switch configuration. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 Naresh 04/06/2018 Initial creation 1.1 Naresh
07/11/2018 Updated copyright info 1.2 Hyun 10/03/2018 Added the event port
select function 1.3 Hyun 10/08/2018 Added the offset for shim trace slave port
1.4 Nishad 12/05/2018 Renamed ME attributes to AIE 1.5 Wendy 16/05/2019 Wrap
pointers parameters with () in macro </pre>

FILES:
XilinxProcessorIPLib/drivers/aiengine/src/tile/xaietile_strm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 vve 14/08/18 Initial release

FILES:
XilinxProcessorIPLib/drivers/audio_formatter/data/audio_formatter.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"),to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xaudioformatter_example.c
This is main file for the Audio Formatter example design. This file contains an
example for using the audio formatter with I2S receiver and I2S transmitter
device using interrupt mode. This example assumes that the interrupt controller
is also present as a part of the system. The audio is received from external
device through i2s receiver and given to audio formatter through axi stream
interface, audio formatter writes the output to memory through DMA transfer from
where another instance of audio formatter reads it and send to i2s transmitter
for playback. In this example we wait for IOC interrupts from the audio
formatter S2MM and MM2S cores and on receiving both the interrupts along with
i2srx and i2stx interrupts we stop audio formatter and print the test is
successfull. /

FILES:
XilinxProcessorIPLib/drivers/audio_formatter/examples/xaudioformatter_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaudioformatter.c @addtogroup
audio_formatter_v1_0 @{ This file contains the implementation of the interface
functions for audio formater driver. Refer to the header file xaudioformatter.h
for more detailed information. Include Files /

FILES:
XilinxProcessorIPLib/drivers/audio_formatter/src/xaudioformatter.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. <b>Initialization & Configuration</b>
The device driver enables higher layer software (e.g., an application) to
communicate to the Audio Formatter core. XAudioFormatter_CfgInitialize() API is
used to initialize the Audio Formatter core. The user needs to first call the
XAudioFormatter_LookupConfig() API which returns the Configuration structure
pointer which is passed as a parameter to the XAudioFormatter_CfgInitialize()
API. <b> Interrupts </b> The driver does the interrupt handling, and dispatch to
the user application through callback functions that user has registered. <b>
Virtual Memory </b> This driver supports Virtual Memory. The RTOS is responsible
for calculating the correct device base address in Virtual Memory space. <b>
Threads </b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver. <b> Asserts
</b> Asserts are used within all Xilinx drivers to enforce constraints on
argument values. Asserts can be turned off on a system-wide basis by defining,
at compile time, the NDEBUG identifier. By default, asserts are turned on and it
is recommended that users leave asserts on during development. @file
xaudioformatter.h @addtogroup audio_formatter_v1_0 @{ @details This header file
contains identifiers and register-level driver functions (or macros), range
macros, structure typedefs that can be used to access the Xilinx Audio Formatter
core instance.

FILES:
XilinxProcessorIPLib/drivers/audio_formatter/src/xaudioformatter.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaudioformatter_hw.h
@addtogroup audioformatter_v1_0 @{ This header file contains identifiers and
register-level driver functions (or macros) that can be used to access the
Xilinx audio_formatter core.

FILES:
XilinxProcessorIPLib/drivers/audio_formatter/src/xaudioformatter_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaudioformatter_intr.c
@addtogroup audioformatter_v1_0 @{ This file contains interrupt related
functions of Xilinx Audio Formatter core. Include Files /

FILES:
XilinxProcessorIPLib/drivers/audio_formatter/src/xaudioformatter_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaudioformatter_sinit.c @addtogroup audio_formatter_v1_0 @{ This file contains
static initialization methods for Xilinx audio formatter core. Include Files /

FILES:
XilinxProcessorIPLib/drivers/audio_formatter/src/xaudioformatter_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 aad 07/27/17 Created uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/avbuf/data/avbuf.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavbuf.c This file implements
all the functions related to the Video Pipeline of the DisplayPort Subsystem.
See xavbuf.h for the detailed description of the driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 06/24/17
Initial release. 2.0 aad 10/08/17 Some APIs to use enums instead of Macros. Some
bug fixes. 2.2 aad 04/26/18 Fixed Warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/avbuf/src/xavbuf.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavbuf.h This file implements
all the functions related to the Video Pipeline of the DisplayPort Subsystem.
Features supported by this driver - Live Video and Graphics input. - Non-Live
Video Graphics input. - Output Formats Supported - RGB, YUV444, YUV4222. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 06/24/17
Initial release. 2.0 aad 10/07/17 Added Enums for Video and Audio sources.
</pre>

FILES:
XilinxProcessorIPLib/drivers/avbuf/src/xavbuf.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavbuf_clk.c This file contains
PLL configuring functions. These Functions calculates and configures the PLL
depending on desired frequency. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 mh 06/24/17 Initial release. 2.1 tu
12/29/17 LPD and FPD offsets adjusted </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/avbuf/src/xavbuf_clk.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavbuf_clk.h This header file
contains the identifiers and low-level driver functions (or macros) that can be
used to configure PLL to generate required frequency. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 mh 06/24/17
Initial release. 2.1 tu 12/29/17 LPD and FPD offsets adjusted </pre>

FILES:
XilinxProcessorIPLib/drivers/avbuf/src/xavbuf_clk.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavbuf_hw.h This header file
contains macros that can be used to access the device @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 02/24/17
Initial Release 1.0 mh 06/24/17 Added Clock related register information 2.0 aad
10/07/17 Removed Macros related to Video and Audio Src </pre>

FILES:
XilinxProcessorIPLib/drivers/avbuf/src/xavbuf_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavbuf_videoformats.c
@addtogroup xavbuf_v2_1 @{ Contains attributes of the video formats mapped to
the hardware @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 aad 03/10/17 Initial release. 2.0 aad 02/22/18 Fixed scaling
factors and bits per pixel </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/avbuf/src/xavbuf_videoformats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's 4.5 rsp 07/06/18 Remove space b/w backslash and newline 4.5 rsp 10/03/18
Fix typos @BEGIN_CHANGELOG EDK_I_SP1 - Added support for generation of multiple
applications. All TCL procedures are now required to have a software project
type as its first argument - Add a new argument to gen_include_files. - Added
logic to check if DDR is present. (CR 700806) @END_CHANGELOG Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/axicdma/data/axicdma_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_example_hybrid_intr.c
This file demonstrates how to use xaxicdma driver on the Xilinx AXI CDMA core
(AXICDMA) to transfer packets in hybrid transfer mode through interrupt. This
example does one simple transfer, then a multiple BD transfer, and finally
another simple transfer. Modify NUMBER_OF_BDS_TO_TRANSFER for a different number
of BDs to be transferred in the SG transfer. This example assumes that the
system has an interrupt controller. To see the debug print, you need a Uart16550
or uartlite in your system, and please set "-DDEBUG" in your compiler options
for the example, also comment out the "undef DEBUG" in xdebug.h. You need to
rebuild your software executable. Make sure that MEMORY_BASE is defined properly
as per the HW system. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a jz 07/30/10 First release 2.01a rkv 02/01/11 Changed
function prototype of XAxiCdma_HybridIntrExample to a function taking arguments
interrupt instance,device instance,device id,device interrupt id Added interrupt
support for Cortex A9 2.01a srt 03/06/12 Modified interrupt support for Zynq.
Added V7 DDR Base Address to fix CR 649405. Modified Flushing and Invalidation
of Caches to fix CRs 648103, 648701. 2.02a srt 03/01/13 Updated DDR base address
for IPI designs (CR 703656). 4.1 adk 01/07/16 Updated DDR base address for
Ultrascale (CR 799532) and removed the defines for S6/V6. 4.3 ms 01/22/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation of examples. 4.4 rsp 02/22/18 Support data buffers
above 4GB.Use UINTPTR for storing and typecasting buffer address(CR-995116).
</pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/examples/xaxicdma_example_hybrid_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_example_hybrid_poll.c
This file demonstrates how to use xaxicdma driver on the Xilinx AXI CDMA core
(AXICDMA) to transfer packets in hybrid transfer mode without interrupt. There
are three transfers: a simple transfer, a sg transfer, and another simple
transfer. The completion of the transfer is checked through polling. Using
polling mode can give better performance on an idle system, where the DMA engine
is lowly loaded, and the application has nothing else to do. The polling mode
can yield better turn-around time for DMA transfers. Modify
NUMBER_OF_BDS_TO_TRANSFER for a different number of BDs to be transferred in the
SG transfer. To see the debug print, you need a uart16550 or uartlite in your
system, and please set "-DDEBUG" in your compiler options for the example, also
comment out the "undef DEBUG" in xdebug.h. You need to rebuild your software
executable. Make sure that MEMORY_BASE is defined properly as per the HW system.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz
07/30/10 First release 2.01a rkv 02/01/11 Modified function prototype of
XAxiCdma_HybridPollExample to a function taking only one arguments i.e. device
id. 2.01a srt 03/06/12 Added V7 DDR Base Address to fix CR 649405. Modified
Flushing and Invalidation of Caches to fix CRs 648103, 648701. 2.02a srt
03/01/13 Updated DDR base address for IPI designs (CR 703656). 4.1 adk 01/07/16
Updated DDR base address for Ultrascale (CR 799532) and removed the defines for
S6/V6. 4.3 ms 01/22/17 Modified xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. ms 04/05/17 Modified Comment lines in functions to
recognize it as documentation block for doxygen generation of examples. 4.4 rsp
02/22/18 Support data buffers above 4GB.Use UINTPTR for storing and typecasting
buffer address(CR-995116). </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/examples/xaxicdma_example_hybrid_poll.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_example_sg_intr.c This
file demonstrates how to use the xaxicdma driver on the Xilinx AXI CDMA core
(AXICDMA) to transfer packets in scatter gather transfer mode through interrupt.
This example assumes that the system has an interrupt controller. To see the
debug print, you need a Uart16550 or uartlite in your system, and please set
"-DDEBUG" in your compiler options for the example, also comment out the "undef
DEBUG" in xdebug.h. You need to rebuild your software executable. Make sure that
MEMORY_BASE is defined properly as per the HW system. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 07/27/10 First
release 2.01a rkv 01/28/11 Changed function prototype of XAxiCdma_SgIntrExample
to a function taking arguments interrupt instance,device instance,device
id,device interrupt id. Added interrupt support for Cortex A9 2.01a srt 03/05/12
Modified interrupt support for Zynq. Added V7 DDR Base Address to fix CR 649405.
Modified Flushing and Invalidation of Caches to fix CRs 648103, 648701. 2.02a
srt 03/01/13 Updated DDR base address for IPI designs (CR 703656). 4.1 adk
01/07/16 Updated DDR base address for Ultrascale (CR 799532) and removed the
defines for S6/V6. 4.3 ms 01/22/17 Modified xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation of
examples. 4.4 rsp 02/22/18 Support data buffers above 4GB.Use UINTPTR for
storing and typecasting buffer address(CR-995116). 4.5 rsp 03/10/18 Fix
compilation error in CheckData function when DEBUG mode is enabled. Reset error
and done states before starting the DMA. </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/examples/xaxicdma_example_sg_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_example_sg_poll.c This
file demonstrates how to use the xaxicdma driver on the Xilinx AXI CDMA core
(AXICDMA) to transfer packets in scatter gather transfer mode without interrupt.
The completion of the transfer is checked through polling. Using polling mode
can give better performance on an idle system, where the DMA engine is lowly
loaded, and the application has nothing else to do. The polling mode can yield
better turn-around time for DMA transfers. To see the debug print, you need a
uart16550 or uartlite in your system, and please set "-DDEBUG" in your compiler
options for the example, also comment out the "undef DEBUG" in xdebug.h. You
need to rebuild your software executable. Make sure that MEMORY_BASE is defined
properly as per the HW system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jz 07/30/10 First release 2.01a rkv 01/28/11 Modified
function prototype of XAxiCdma_SgPollExample to a function taking only one
arguments i.e. device id. 2.01a srt 03/05/12 Added V7 DDR Base Address to fix CR
649405. Modified Flushing and Invalidation of Caches to fix CRs 648103, 648701.
2.02a srt 03/01/13 Updated DDR base address for IPI designs (CR 703656). 4.1 adk
01/07/16 Updated DDR base address for Ultrascale (CR 799532) and removed the
defines for S6/V6. 4.3 ms 01/22/17 Modified xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation of
examples. 4.4 rsp 02/22/18 Support data buffers above 4GB.Use UINTPTR for
typecasting buffer address(CR-995116). </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/examples/xaxicdma_example_sg_poll.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_example_simple_intr.c
This file demonstrates how to use the xaxicdma driver on the Xilinx AXI CDMA
core (AXICDMA) to transfer packets in simple transfer mode through interrupt.
Modify the NUMBER_OF_TRANSFER constant to have different number of simple
transfers done in this test. This example assumes that the system has an
interrupt controller. To see the debug print, you need a Uart16550 or uartlite
in your system, and please set "-DDEBUG" in your compiler options for the
example, also comment out the "undef DEBUG" in xdebug.h. You need to rebuild
your software executable. <pre> MODIFICATION HISTORY: . Updated the debug print
on type casting to avoid warnings on u32. Cast u32 to (unsigned int) to use the
%x format. Ver Who Date Changes ----- ---- -------- 1.00a jz 07/30/10 First
release 2.01a rkv 01/28/11 Changed function prototype of
XAxiCdma_SimpleIntrExample to a function taking arguments interrupt
instance,device instance,device id,device interrupt id Added interrupt support
for Cortex A9 2.01a srt 03/05/12 Modified interrupt support for Zynq. Modified
Flushing and Invalidation of Caches to fix CRs 648103, 648701. 4.3 ms 01/22/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation of examples. 4.4 rsp 02/22/18 Support data buffers
above 4GB.Use UINTPTR for typecasting buffer address(CR-995116). </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/examples/xaxicdma_example_simple_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_example_simple_poll.c
This file demonstrates how to use xaxicdma driver on the Xilinx AXI CDMA core
(AXICDMA) to transfer packets in simple transfer mode without interrupt. The
completion of the transfer is checked through polling. Using polling mode can
give better performance on an idle system, where the DMA engine is lowly loaded,
and the application has nothing else to do. The polling mode can yield better
turn-around time for DMA transfers. Modify NUMBER_OF_TRANSFERS for a different
number of simple transfer to be done in this test. To see the debug print, you
need a Uart16550 or uartlite in your system, and please set "-DDEBUG" in your
compiler options for the example, also comment out the "undef DEBUG" in
xdebug.h. You need to rebuild your software executable. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 07/30/10 First
release 2.01a rkv 01/28/11 Modified function prototype of
XAxiCdma_SimplePollExample to function taking only one arguments i.e. device id.
2.01a srt 03/06/12 Modified Flushing and Invalidation of Caches to fix CRs
648103, 648701. 4.3 ms 01/22/17 Modified xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation of
examples. </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/examples/xaxicdma_example_simple_poll.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma.c @addtogroup
axicdma_v4_5 @{ The implementation of the API of Xilinx CDMA engine. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 04/18/10
First release 2.01a rkv 01/25/11 Replaced with "\r\n" in place on "\n\r" in
printf statements Changed XAxiCdma_CfgInitialize to use EffectiveAddress. 2.02a
srt 01/18/13 Added support for Key Hole feature (CR: 687217). 4.1 sk 11/10/15
Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototype of
XAxiCdma_CfgInitialize API. </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma.h @addtogroup
axicdma_v4_5 @{ @details This is the driver API for the AXI CDMA engine. For a
full description of the features of the AXI CDMA engine, please refer to the
hardware specification. This driver supports the following features: - Simple
DMA transfer - Scatter gather (SG) DMA transfer - Interrupt for error or
completion of transfers - For SG DMA transfer: - Programmable interrupt
coalescing - Programmable delay timer counter - Managing the buffer descriptors
(BDs) <b>Two Hardware Building Modes</b> The hardware can be built in two modes:
- <b>Simple only mode</b>, in this mode, only simple transfers are supported by
the hardware. The functionality is similar to the XPS Central DMA, however, the
driver API to do the transfer is slightly different. - <b>Hybrid mode</b>, in
this mode, the hardware supports both the simple transfer and the SG transfer.
However, only one kind of transfer can be active at a time. If an SG transfer is
ongoing in the hardware, a submission of a simple transfer fails. If a simple
transfer is ongoing in the hardware, a submission of an SG transfer is
successful, however the SG transfer will not start until the simple transfer is
done. <b>Transactions</b> The hardware supports two types of transfers, the
simple DMA transfer and the scatter gather (SG) DMA transfer. A simple DMA
transfer only needs source buffer address, destination buffer address and
transfer length to do a DMA transfer. Only one transfer can be submitted to the
hardware at a time. A SG DMA transfer requires setting up a buffer descriptor
(BD), which keeps the transfer information, including source buffer address,
destination buffer address, and transfer length. The hardware updates the BD for
the completion status of the transfer. BDs that are connected to each other can
be submitted to the hardware at once, therefore, the SG DMA transfer has better
performance when the application is doing multiple transfers each time.
<b>Callback Function</b> Each transfer, for which the application cares about
its completion, should provide with the driver its callback function. The
signature of the callback function is as the following: void
XAxiCdma_CallBackFn(void CallBackRef, u32 IrqMask, int NumPtr); Where the
CallBackRef is a reference pointer that the application passes to the driver
along with the callback function. The driver passes IrqMask to the application
when it calls this callback. The NumPtr is only used in SG mode to track how
many BDs still left for this callback function. The callback function is set
upon transfer submission: - Simple transfer callback function setup: <b>Only set
the callback function if in interrupt mode.</b> For simple transfers, the
callback function along with the callback reference pointer is passed to the
driver through the submission of the simple transfer:
XAxiCdma_SimpleTransfer(...) - SG transfer callback function setup: For SG
transfers, the callback function and the callback reference pointer are set
through the transfer submission call: XAxiCdma_BdRingToHw(...) <b>Simple
Transfers</b> For an application that only does one DMA transfer at a time, and
the DMA engine is exclusively used by this application, simple DMA transfer is
sufficient. Using the simple DMA transfer has the advantage of ease of use
comparing to SG DMA transfer. For an individual DMA transfer, simple DMA
transfer is also faster because of simplicity in software and hardware.
<b>Scatter Gather (SG) Transfers</b> For an application that has multiple DMA
transfers sometimes, or the DMA engine is shared by multiple applications, using
SG DMA transfer yields better performance over all applications. The SG DMA
transfer provides queuing of multiple transfers, therefore, it provides better
performance because the hardware can continuously work on all submitted
transfers without software intervention. The down side of using the SG DMA
transfer is that you have to manage the memory for the buffer descriptors (BD),
and setup BDs for the transfers. <b>Interrupts</b> The driver handles the
interrupts. The completion of a transfer, that has a callback function
associated with, will trigger the driver to call the callback function. The
IrqMask that is passed through the callback function notifies the application
about the completion status of the transfer. <b>Interrupt Coalescing for SG
Transfers</b> For SG transfers, the application can program the interrupt
coalescing threshold to reduce the frequency of interrupts. If the number of
transfers does not match well with the interrupt coalescing threshold, the
completion of the last transfer will not trigger the completion interrupt.
However, after the specified delay count time, the delay interrupt will fire. By
default, the interrupt threshold for the hardware is one, which is one interrupt
per BD completion. <b>Delay Interrupt for SG Transfers</b> Delay interrupt is to
signal the application about inactivity of transfers. If the delay interrupt is
enabled, the delay timer starts counting down once a transfer has started. If
the interval between transfers is longer than the delay counter, the delay
interrupt is fired. By default, the delay counter is zero, which means the delay
interrupt is disabled. To enable delay interrupt, the delay interrupt enable bit
must be set and the delay counter must be set to a value between 1 to 255. <b>BD
management for SG DMA Transfers </b> BD is shared by the software and the
hardware. To use BD for SG DMA transfers, the application needs to use the
driver API to do the following: - Setup the BD ring: -
XAxiCdma_BdRingCreate(...) Note that the memory for the BD ring is allocated and
is later de-allocated by the application. - Request BD from the BD ring, more
than one BDs can be requested at once: - XAxiCdma_BdRingAlloc(...) - Prepare BDs
for the transfer, one BD at a time: - XAxiCdma_BdSetSrcBufAddr(...) -
XAxiCdma_BdSetDstBufAddr(...) - XAxiCdma_BdSetLength(...) - Submit all prepared
BDs to the hardware: - XAxiCdma_BdRingToHw(...) - Upon transfer completion, the
application can request completed BDs from the hardware: -
XAxiCdma_BdRingFromHw(...) - After the application has finished using the BDs,
it should free the BDs back to the free pool: - XAxiCdma_BdRingFree(...) The
driver also provides API functions to get the status of a completed BD, along
with get functions for other fields in the BD. The following two diagrams show
the correct flow of BDs: The first diagram shows a complete cycle for BDs,
starting from requesting the BDs to freeing the BDs. <pre>
XAxiCdma_BdRingAlloc() XAxiCdma_BdRingToHw() Free ---------------------- Pre-
process -------------------- Hardware | /|\ | | XAxiCdma_BdRingFree()
XAxiCdma_BdRingFromHw() | +--------------------------- Post-process
<----------------------+ </pre> The second diagram shows when a DMA transfer is
to be cancelled before enqueuing to the hardware, application can return the
requested BDs to the free group using XAxiCdma_BdRingUnAlloc(). <pre>
XAxiCdma_BdRingUnAlloc() Free <----------------------- Pre-process </pre>
<b>Physical/Virtual Addresses</b> Addresses for the transfer buffers are
physical addresses. For SG transfers, the next BD pointer in a BD is also a
physical address. However, application's reference to a BD and to the transfer
buffers are through virtual addresses. The application is responsible to
translate the virtual addresses of its transfer buffers to physical addresses
before handing them to the driver. For systems where MMU is not used, or MMU is
a direct mapping, then the physical address and the virtual address are the
same. <b>Cache Coherency</b> To prevent cache and memory inconsistency: - Flush
the transmit buffer range before the transfer - Invalidate the receive buffer
range before passing it to the hardware and before passing it to the application
For SG transfers: - Flush the BDs once the preparation setup is done -
Invalidate the memory region for BDs when BDs are retrieved from the hardware.
<b>BD alignment for SG Transfers</b> The hardware has requirement for the
minimum alignment of the BDs, XAXICDMA_BD_MINIMUM_ALIGNMENT. It is OK to have an
alignment larger than the required minimum alignment, however, it must be
multiple of the minimum alignment. The alignment is passed into
XAxiCdma_BdRingCreate(). <b>Error Handling</b> The hardware halts upon all error
conditions. The driver will reset the hardware once the error occurs. The
IrqMask argument in the callback function notifies the application about error
conditions for the transfer. <b>Mutual Exclusion</b> The driver does not provide
mutual exclusion mechanisms, it is up to the upper layer to handle this.
<b>Hardware Defaults & Exclusive Use</b> The hardware is in the following
condition on start or after a reset: - All interrupts are disabled. - The engine
is in simple mode. - Interrupt coalescing counter is one. - Delay counter is 0.
The driver has exclusive use of the hardware registers and BDs. Accessing the
hardware registers or the BDs should always go through the driver API functions.
<b>Hardware Features That User Should Be Aware of</b> For performance reasons,
the driver does not check the submission of transfers during run time. It is the
user's responsibility to submit approrpiate transfers to the hardware. The
following hardware features should be considerred when submitting a transfer: .
Whether the hardware supports unaligned transfers, reflected through
C_INCLUDE_DRE in system.mhs file. Submitting unaligned transfers while the
hardware does not support it, causes errors upon transfer submission. Aligned
transfer is in respect to word length, and word length is defined through the
building parameter XPAR_AXI_CDMA_0_M_AXI_DATA_WIDTH. . Memory range of the
transfer addresses. Transfer data to executable memory can crash the system. .
Lite mode. To save hardware resources (drastically), you may select "lite" mode
build of the hardware. However, with lite mode, the following features are _not_
supported: - Cross page boundary transfer. Each transfer must be restrictly
inside one page; otherwise, slave error occurs. - Unaligned transfer. - Data
width larger than 64 bit - Maximum transfer length each time is limited to
data_width burst_len <pre> MODIFICATION HISTORY: . Updated the debug print on
type casting to avoid warnings on u32. Cast u32 to (unsigned int) to use the %x
format. Ver Who Date Changes ----- ---- -------- 1.00a jz 07/08/10 First release
2.01a rkv 01/25/11 Added TCL script to generate Test App code for peripheral
tests. Replaced with "\r\n" in place on "\n\r" in printf statements. Made some
minor modifications for Doxygen 2.02a srt 01/18/13 Added support for Key Hole
feature (CR: 687217). Updated DDR base address for IPI designs (CR 703656).
2.03a srt 04/13/13 Removed Warnings (CR 705006). Added logic to check if DDR is
present in the test app tcl file. (CR 700806) 3.0 adk 19/12/13 Updated as per
the New Tcl API's 4.0 adk 27/07/15 Added support for 64-bit Addressing. 4.1 sk
11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototype of XAxiCdma_CfgInitialize API. 4.3 mi 09/21/16 Fixed compilation
warnings. ms 01/22/17 Modified xil_printf statement in main function for all
examples to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/05/17 Modified Comment lines in
functions of axicdma examples to recognize it as documentation block for doxygen
generation of examples. </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_bd.c @addtogroup
axicdma_v4_5 @{ The implementation for the Buffer Descriptor (BD) API functions.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz
04/08/10 First release 2.01a rkv 01/25/11 Replaced with "\r\n" in place of
"\n\r" in printf statements </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_bd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_bd.h @addtogroup
axicdma_v4_5 @{ The API definition for the Buffer Descriptor (BD). <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 04/16/10
First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_bd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_bdring.c @addtogroup
axicdma_v4_5 @{ Implementation for support on Scatter Gather (SG) transfers. It
includes the implementation of the BD ring API. There is only one BD ring per
DMA engine. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a jz 04/18/10 First release 2.01a rkv 01/25/11 Replaced with "\r\n" in place
on "\n\r" in printf statements 4.3 mi 09/21/16 Fixed compilation warnings 4.5
rsp 07/04/18 Fixed cppcheck warning </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_bdring.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_g.c @addtogroup
axicdma_v4_5 @{ Provide a template for user to define their own hardware
settings. If using XPS, XPS will automatically generate this file. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 08/16/10
First release 4.5 rsp 07/04/18 Sync XAxiCdma_Config initializer fields </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_hw.h @addtogroup
axicdma_v4_5 @{ Hardware definition file. It defines the register interface and
Buffer Descriptor (BD) definitions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a jz 04/08/10 First release 2.02a srt 01/18/13
Added support for Key Hole feature (CR: 687217). </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_i.h @addtogroup
axicdma_v4_5 @{ Header file for utility functions shared by driver files. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 04/16/10
First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_intr.c @addtogroup
axicdma_v4_5 @{ The implementation of the interrupt related API. The interrupt
handler is also implemented here. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a jz 07/08/10 First release 2.01a rkv 01/25/11
Replaced with "\r\n" in place on "\n\r" in printf statements 2.03a srt 04/13/13
Removed Warnings (CR 705006). </pre> /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_porting_guide.h
@addtogroup axicdma_v4_5 @{ This is a guide on how to move from using the XPS
Central DMA driver, dmacentral, to use xaxidma driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 08/18/10 First
release </pre> <b>Overview</b> The AXI Central DMA engine is to replace the XPS
Central DMA engine using the AXI bus interface. The AXI Central DMA hardware is
different from the XPS Central DMA engine. The APS Central DMA engine only
supports simple mode transfer, where only one buffer transfer can be sumitted to
the hardware each time. The AXI Central DMA engine, on the other hand, also
supports scatter gather transfers, where each submission to the hardware can
have multiple buffers. Each transfer buffer is defined by a buffer descriptor
(BD). The AXI Central DMA engine can be configured at build time to be in simple
mode only, which is similar to the XPS Central DMA. It can also be configured as
hybrid mode, where scatter gather mode is also supported. <b>Simple Mode API
Difference</b> The difference from the driver API level is as the following: -
User defined interrupt handler is no longer directly connected to the interrupt
controller. Instead, it is registered as a call back function when the submit
the transfer: <pre> XAxiCdma_SimpleTransfer(InstancePtr, TxAddr, RxAddr, Length,
CallBackFn, CallBackRef); </pre> Please refer to example_simple_intr.c to see
how it is used. - Transfer submission API is different: Before: <pre>
XDmaCentral_Transfer(...) </pre> Now: <pre> XAxiCdma_SimpleTransfer(...) </pre>
Note that arguments list is also different. Please see example_simple_poll.c or
example_simple_intr.c for how to submit simple transfers. - Polling for transfer
completion is different: Before: <pre> do { RegValue
XDmaCentral_GetStatus(DmaInstance); } while ((RegValue & XDMC_DMASR_BUSY_MASK)
XDMC_DMASR_BUSY_MASK); </pre> Now: <pre> while (XAxiCdma_IsBusy(InstancePtr)) {
; } </pre> @} /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_porting_guide.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxicdma_sinit.c @addtogroup
axicdma_v4_5 @{ Look up the hardware settings using device ID. The hardware
setting is inside the configuration table in xaxivdma_g.c, generated
automatically by XPS or manually by user. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a jz 08/16/10 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/axicdma/src/xaxicdma_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 8.0 adk 12/10/13 Updated as per the New Tcl
API's 9.7 rsp 04/25/18 Read c_sg_length_width from IP. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/axidma/data/axidma.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/axidma/data/axidma_tapp.tcl
XilinxProcessorIPLib/drivers/axivdma/data/axivdma_tapp.tcl
XilinxProcessorIPLib/drivers/csi/data/csi_tapp.tcl
XilinxProcessorIPLib/drivers/csi2tx/data/csi2tx_tapp.tcl
XilinxProcessorIPLib/drivers/csi2txss/data/csi2txss_tapp.tcl
XilinxProcessorIPLib/drivers/dphy/data/dphy_tapp.tcl
XilinxProcessorIPLib/drivers/mipicsiss/data/mipicsiss_tapp.tcl
XilinxProcessorIPLib/drivers/v_sdirxss/data/v_sdirxss_tapp.tcl
XilinxProcessorIPLib/drivers/v_sditxss/data/v_sditxss_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxidma_example_multichan_sg_intr.c This file demonstrates how to use the
xaxidma driver on the Xilinx AXI DMA core v6_00_a (AXIDMA) to transfer packets
in interrupt mode for Multiple Channel capability. Thi example is designed to
work only when AXIDMA core is configured in Scatter Gather Mode and Multiple
Channel mode. We show how to do multiple packets transfers, as well as how to do
multiple BDs per packet transfers. This code is tested only with two channels on
both Tx and Rx. This code assumes a loopback hardware widget is connected to the
AXI DMA core for data packet loopback. The loopback widget is configured in a
way that, when a packet is transmitted on "Tx Channel 0" it will be received on
the "Rx channel 1" and if "Tx Channel 1" it is on Rx Channel 0. Both the cases
are included in this example. To see the debug print, you need a Uart16550 or
uartlite in your system, and please set "-DDEBUG" in your compiler options. You
need to rebuild your software executable. Make sure that MEMORY_BASE is defined
properly as per the HW system. The h/w system built in Area mode has a maximum
DDR memory limit of 64MB. In throughput mode, it is 512MB. These limits are need
to ensured for proper operation of this code. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a srt 03/27/12 First release 2.00a srt
06/18/12 API calls are reverted back for backward compatibility. 2.01a srt
11/02/12 Buffer sizes (Tx and Rx) are modified to meet maximum DDR memory limit
of the h/w system built with Area mode 7.02a srt 03/01/13 Updated DDR base
address for IPI designs (CR 703656). 9.1 adk 01/07/16 Updated DDR base address
for Ultrascale (CR 799532) and removed the defines for S6/V6. 9.3 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. 9.6 rsp 02/14/18 Support data buffers
above 4GB. Use UINTPTR for storing and typecasting buffer address(CR-992638).
9.9 rsp 01/21/19 Fix use of elif check in deriving DDR_BASE_ADDR. </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_multichan_sg_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxidma_example_poll_multi_pkts.c This file demonstrates how to use the xaxidma
driver on the Xilinx AXI DMA core (AXIDMA) to transfer multiple packets in
polling mode when the AXI DMA core is configured in Scatter Gather Mode. This
code assumes a loopback hardware widget is connected to the AXI DMA core for
data packet loopback. To see the debug print, you need a Uart16550 or uartlite
in your system, and please set "-DDEBUG" in your compiler options. You need to
rebuild your software executable. Make sure that MEMORY_BASE is defined properly
as per the HW system. The h/w system built in Area mode has a maximum DDR memory
limit of 64MB. In throughput mode, it is 512MB. These limits are need to ensured
for proper operation of this code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a jz 05/17/10 First release 2.00a jz 08/10/10
Second release, added in xaxidma_g.c, xaxidma_sinit.c, updated tcl file, added
xaxidma_porting_guide.h, removed workaround for endianness 4.00a rkv 02/22/11
Name of the file has been changed for naming consistency 5.00a srt 03/06/12
Added Flushing and Invalidation of Caches to fix CRs 648103, 648701. Added V7
DDR Base Address to fix CR 649405. 6.00a srt 03/27/12 Changed API calls to
support MCDMA driver. 7.00a srt 06/18/12 API calls are reverted back for
backward compatibility. 7.02a srt 03/01/13 Updated DDR base address for IPI
designs (CR 703656). 9.1 adk 01/07/16 Updated DDR base address for Ultrascale
(CR 799532) and removed the defines for S6/V6. 9.3 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. 9.5 adk 17/10/17 Marked the BD region as
Normal Non-Cacheable for A53 (CR987026). 9.6 rsp 02/14/18 Support data buffers
above 4GB.Use UINTPTR for storing and typecasting buffer address(CR-992638). 9.9
rsp 01/21/19 Fix use of elif check in deriving DDR_BASE_ADDR. </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_poll_multi_pkts.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_example_selftest.c This
file demonstrates the example to do selftest on the device. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 9.3 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation of examples. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_example_sg_intr.c This
file demonstrates how to use the xaxidma driver on the Xilinx AXI DMA core
(AXIDMA) to transfer packets in interrupt mode when the AXIDMA core is
configured in Scatter Gather Mode We show how to do multiple packets transfers,
as well as how to do multiple BDs per packet transfers. This code assumes a
loopback hardware widget is connected to the AXI DMA core for data packet
loopback. To see the debug print, you need a Uart16550 or uartlite in your
system, and please set "-DDEBUG" in your compiler options. You need to rebuild
your software executable. Make sure that MEMORY_BASE is defined properly as per
the HW system. The h/w system built in Area mode has a maximum DDR memory limit
of 64MB. In throughput mode, it is 512MB. These limits are need to ensured for
proper operation of this code. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jz 05/18/10 First release 2.00a jz 08/10/10 Second
release, added in xaxidma_g.c, xaxidma_sinit.c, updated tcl file, added
xaxidma_porting_guide.h, removed workaround for endianness 4.00a rkv 02/22/11
Name of the file has been changed for naming consistency Added interrupt support
for Zynq. 5.00a srt 03/05/12 Added Flushing and Invalidation of Caches to fix
CRs 648103, 648701. Added V7 DDR Base Address to fix CR 649405. 6.00a srt
01/24/12 Changed API calls to support MCDMA driver. 7.00a srt 06/18/12 API calls
are reverted back for backward compatibility. 7.01a srt 11/02/12 Buffer sizes
(Tx and Rx) are modified to meet maximum DDR memory limit of the h/w system
built with Area mode 7.02a srt 03/01/13 Updated DDR base address for IPI designs
(CR 703656). 9.1 adk 01/07/16 Updated DDR base address for Ultrascale (CR
799532) and removed the defines for S6/V6. 9.3 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Added tabspace for return statements in functions for proper documentation while
generating doxygen. 9.6 rsp 02/14/18 Support data buffers above 4GB.Use UINTPTR
for storing and typecasting buffer address(CR-992638). 9.9 rsp 01/21/19 Fix use
of elif check in deriving DDR_BASE_ADDR. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_sg_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_example_sg_poll.c This
file demonstrates how to use the xaxidma driver on the Xilinx AXI DMA core
(AXIDMA) to transfer packets in polling mode when the AXIDMA core is configured
in Scatter Gather Mode. This code assumes a loopback hardware widget is
connected to the AXI DMA core for data packet loopback. To see the debug print,
you need a Uart16550 or uartlite in your system, and please set "-DDEBUG" in
your compiler options. You need to rebuild your software executable. Make sure
that MEMORY_BASE is defined properly as per the HW system. The h/w system built
in Area mode has a maximum DDR memory limit of 64MB. In throughput mode, it is
512MB. These limits are need to ensured for proper operation of this code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 05/17/10
First release 2.00a jz 08/10/10 Second release, added in xaxidma_g.c,
xaxidma_sinit.c, updated tcl file, added xaxidma_porting_guide.h, removed
workaround for endianness 4.00a rkv 02/22/11 Name of the file has been changed
for naming consistency Added interrupt support for ARM. 5.00a srt 03/05/12 Added
Flushing and Invalidation of Caches to fix CRs 648103, 648701. Added V7 DDR Base
Address to fix CR 649405. 6.00a srt 03/27/12 Changed API calls to support MCDMA
driver. 7.00a srt 06/18/12 API calls are reverted back for backward
compatibility. 7.01a srt 11/02/12 Buffer sizes (Tx and Rx) are modified to meet
maximum DDR memory limit of the h/w system built with Area mode 7.02a srt
03/01/13 Updated DDR base address for IPI designs (CR 703656). 9.1 adk 01/07/16
Updated DDR base address for Ultrascale (CR 799532) and removed the defines for
S6/V6. 9.2 vak 15/04/16 Fixed compilation warnings in th example 9.3 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
9.9 rsp 01/21/19 Fix use of elif check in deriving DDR_BASE_ADDR. </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_sg_poll.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_example_sgcyclic_intr.c
This file demonstrates how to use the xaxidma driver on the Xilinx AXI DMA core
(AXIDMA) to transfer packets in interrupt mode when the AXIDMA core is
configured in Scatter Gather Mode This example demonstrates how to use cyclic
DMA mode feature. This program will recycle the NUMBER_OF_BDS_TO_TRANSFER buffer
descriptors to specified number of cyclic transfers defined in
"NUMBER_OF_CYCLIC_TRANSFERS". This code assumes a loopback hardware widget is
connected to the AXI DMA core for data packet loopback. To see the debug print,
you need a Uart16550 or uartlite in your system, and please set "-DDEBUG" in
your compiler options. You need to rebuild your software executable. Make sure
that MEMORY_BASE is defined properly as per the HW system. The h/w system built
in Area mode has a maximum DDR memory limit of 64MB. In throughput mode, it is
512MB. These limits are need to ensured for proper operation of this code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 9.4 adk 25/07/17
Initial version. 9.6 rsp 02/14/18 Support data buffers above 4GB.Use UINTPTR for
storing and typecasting buffer address(CR-992638). 9.8 rsp 07/24/18 Set TX
DMACR[Cyclic BD enable] before starting DMA operation i.e. in TxSetup. 9.9 rsp
01/21/19 Fix use of elif check in deriving DDR_BASE_ADDR. rsp 02/05/19 For test
completion wait for both TX and RX done counters. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_sgcyclic_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_example_simple_intr.c
This file demonstrates how to use the xaxidma driver on the Xilinx AXI DMA core
(AXIDMA) to transfer packets.in interrupt mode when the AXIDMA core is
configured in simple mode This code assumes a loopback hardware widget is
connected to the AXI DMA core for data packet loopback. To see the debug print,
you need a Uart16550 or uartlite in your system, and please set "-DDEBUG" in
your compiler options. You need to rebuild your software executable. Make sure
that MEMORY_BASE is defined properly as per the HW system. The h/w system built
in Area mode has a maximum DDR memory limit of 64MB. In throughput mode, it is
512MB. These limits are need to ensured for proper operation of this code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 4.00a rkv
02/22/11 New example created for simple DMA, this example is for simple
DMA,Added interrupt support for Zynq. 4.00a srt 08/04/11 Changed a typo in the
RxIntrHandler, changed XAXIDMA_DMA_TO_DEVICE to XAXIDMA_DEVICE_TO_DMA 5.00a srt
03/06/12 Added Flushing and Invalidation of Caches to fix CRs 648103, 648701.
Added V7 DDR Base Address to fix CR 649405. 6.00a srt 03/27/12 Changed API calls
to support MCDMA driver. 7.00a srt 06/18/12 API calls are reverted back for
backward compatibility. 7.01a srt 11/02/12 Buffer sizes (Tx and Rx) are modified
to meet maximum DDR memory limit of the h/w system built with Area mode 7.02a
srt 03/01/13 Updated DDR base address for IPI designs (CR 703656). 9.1 adk
01/07/16 Updated DDR base address for Ultrascale (CR 799532) and removed the
defines for S6/V6. 9.2 vak 15/04/16 Fixed compilation warnings in the example
9.3 ms 01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. 9.6 rsp 02/14/18 Support data buffers above 4GB.Use UINTPTR
for typecasting buffer address (CR-992638). 9.9 rsp 01/21/19 Fix use of elif
check in deriving DDR_BASE_ADDR. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_simple_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_example_simple_poll.c
This file demonstrates how to use the xaxidma driver on the Xilinx AXI DMA core
(AXIDMA) to transfer packets in polling mode when the AXI DMA core is configured
in simple mode. This code assumes a loopback hardware widget is connected to the
AXI DMA core for data packet loopback. To see the debug print, you need a
Uart16550 or uartlite in your system, and please set "-DDEBUG" in your compiler
options. You need to rebuild your software executable. Make sure that
MEMORY_BASE is defined properly as per the HW system. The h/w system built in
Area mode has a maximum DDR memory limit of 64MB. In throughput mode, it is
512MB. These limits are need to ensured for proper operation of this code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 4.00a rkv
02/22/11 New example created for simple DMA, this example is for simple DMA
5.00a srt 03/06/12 Added Flushing and Invalidation of Caches to fix CRs 648103,
648701. Added V7 DDR Base Address to fix CR 649405. 6.00a srt 03/27/12 Changed
API calls to support MCDMA driver. 7.00a srt 06/18/12 API calls are reverted
back for backward compatibility. 7.01a srt 11/02/12 Buffer sizes (Tx and Rx) are
modified to meet maximum DDR memory limit of the h/w system built with Area mode
7.02a srt 03/01/13 Updated DDR base address for IPI designs (CR 703656). 9.1 adk
01/07/16 Updated DDR base address for Ultrascale (CR 799532) and removed the
defines for S6/V6. 9.3 ms 01/23/17 Modified xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation of
examples. 9.9 rsp 01/21/19 Fix use of elif check in deriving DDR_BASE_ADDR.
</pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/examples/xaxidma_example_simple_poll.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma.c @addtogroup
axidma_v9_9 @{ This file implements DMA engine-wise initialization and control
functions. For more information on the implementation of this driver, see
xaxidma.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a jz 05/18/10 First release 2.00a jz 08/10/10 Second release, added in
xaxidma_g.c, xaxidma_sinit.c, updated tcl file, added xaxidma_porting_guide.h
3.00a jz 11/22/10 Support IP core parameters change 4.00a rkv 02/22/11 Added
support for simple DMA mode New API added for simple DMA mode are - XAxiDma_Busy
- XAxiDma_SimpleTransfer 6.00a srt 01/24/12 Added support for Multi-Channel DMA
mode. - Changed APIs: XAxiDma_Start(XAxiDma InstancePtr, int RingIndex)
XAxiDma_Started(XAxiDma InstancePtr, int RingIndex) XAxiDma_Pause(XAxiDma
InstancePtr, int RingIndex) XAxiDma_Resume(XAxiDma InstancePtr, int RingIndex)
XAxiDma_SimpleTransfer(XAxiDma InstancePtr, u32 BuffAddr, u32 Length, int
Direction, int RingIndex) - New API: XAxiDma_SelectKeyHole(XAxiDma InstancePtr,
int Direction, int Select) 7.00a srt 06/18/12 All the APIs changed in v6_00_a
are reverted back for backward compatibility. 7.01a srt 10/26/12 Fixed issue
with driver as it fails with IP version < 6.00a as the parameter C_NUM__CHANNELS
is not applicable. 8.0 srt 01/29/14 Added support for Micro DMA Mode and Cyclic
mode of operations. - New API: XAxiDma_SelectCyclicMode(XAxiDma InstancePtr, int
Direction, int Select) 9.1 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. 9.1 vak 11/18/15 Removed warnings in the driver and
examples (CR 911664) 9.5 adk 26/10/17 Fix race condition in the XAxiDma_Reset()
API. This API assumes a tx channel is always present it may be configured for rx
only. 9.6 rsp 01/11/18 In XAxiDma_Reset() use UINTPTR for storing RegBase
CR976392 9.7 rsp 04/25/18 Add support for 64MB data transfer. Read max buffer
length width from config structure. CR 1000474 9.8 rsp 07/11/18 Fix cppcheck
style warnings. CR 1006164 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma.h @addtogroup
axidma_v9_9 @{ @details This is the driver API for the AXI DMA engine. For a
full description of DMA features, please see the hardware spec. This driver
supports the following features: - Scatter-Gather DMA (SGDMA) - Simple DMA -
Interrupts - Programmable interrupt coalescing for SGDMA - APIs to manage Buffer
Descriptors (BD) movement to and from the SGDMA engine <b>Simple DMA</b> Simple
DMA allows the application to define a single transaction between DMA and
Device. It has two channels: one from the DMA to Device and the other from
Device to DMA. Application has to set the buffer address and length fields to
initiate the transfer in respective channel. <b>Transactions</b> The object used
to describe a transaction is referred to as a Buffer Descriptor (BD). Buffer
descriptors are allocated in the user application. The user application needs to
set buffer address, transfer length, and control information for this transfer.
The control information includes SOF and EOF. Definition of those masks are in
xaxidma_hw.h <b>Scatter-Gather DMA</b> SGDMA allows the application to define a
list of transactions in memory which the hardware will process without further
application intervention. During this time, the application is free to continue
adding more work to keep the Hardware busy. User can check for the completion of
transactions through polling the hardware, or interrupts. SGDMA processes whole
packets. A packet is defined as a series of data bytes that represent a message.
SGDMA allows a packet of data to be broken up into one or more transactions. For
example, take an Ethernet IP packet which consists of a 14 byte header followed
by a 1 or more bytes of payload. With SGDMA, the application may point a BD to
the header and another BD to the payload, then transfer them as a single
message. This strategy can make a TCP/IP stack more efficient by allowing it to
keep packet header and data in different memory regions instead of assembling
packets into contiguous blocks of memory. <b>BD Ring Management</b> BD rings are
shared by the software and the hardware. The hardware expects BDs to be setup as
a linked list. The DMA hardware walks through the list by following the next
pointer field of a completed BD. The hardware stops processing when the just
completed BD is the same as the BD specified in the Tail Ptr register in the
hardware. The last BD in the ring is linked to the first BD in the ring. All BD
management are done inside the driver. The user application should not directly
modify the BD fields. Modifications to the BD fields should always go through
the specific API functions. Within the ring, the driver maintains four groups of
BDs. Each group consists of 0 or more adjacent BDs: - Free: The BDs that can be
allocated by the application with XAxiDma_BdRingAlloc(). - Pre-process: The BDs
that have been allocated with XAxiDma_BdRingAlloc(). These BDs are under
application control. The application modifies these BDs through driver API to
prepare them for DMA transactions. - Hardware: The BDs that have been enqueued
to hardware with XAxiDma_BdRingToHw(). These BDs are under hardware control and
may be in a state of awaiting hardware processing, in process, or processed by
hardware. It is considered an error for the application to change BDs while they
are in this group. Doing so can cause data corruption and lead to system
instability. - Post-process: The BDs that have been processed by hardware and
have been extracted from the Hardware group with XAxiDma_BdRingFromHw(). These
BDs are under application control. The application can check the transfer status
of these BDs. The application use XAxiDma_BdRingFree() to put them into the Free
group. BDs are expected to transition in the following way for continuous DMA
transfers: <pre> XAxiDma_BdRingAlloc() XAxiDma_BdRingToHw() Free
---------------------- Pre-process -------------------- Hardware | /|\ | |
XAxiDma_BdRingFree() XAxiDma_BdRingFromHw() | +--------------------------- Post-
process <----------------------+ </pre> When a DMA transfer is to be cancelled
before enqueuing to hardware, application can return the requested BDs to the
Free group using XAxiDma_BdRingUnAlloc(), as shown below: <pre>
XAxiDma_BdRingUnAlloc() Free <----------------------- Pre-process </pre> The API
provides functions for BD list traversal: - XAxiDma_BdRingNext() -
XAxiDma_BdRingPrev() These functions should be used with care as they do not
understand where one group ends and another begins. <b>SGDMA Descriptor Ring
Creation</b> BD ring is created using XAxiDma_BdRingCreate(). The memory for the
BD ring is allocated by the application, and it has to be contiguous. Physical
address is required to setup the BD ring. The application can use
XAxiDma_BdRingMemCalc() to find out the amount of memory needed for a certain
number of BDs. XAxiDma_BdRingCntCalc() can be used to find out how many BDs can
be allocated for certain amount of memory. A helper function,
XAxiDma_BdRingClone(), can speed up the BD ring setup if the BDs have same types
of controls, for example, SOF and EOF. After using the XAxiDma_BdRingClone(),
the application only needs to setup the buffer address and transfer length. Note
that certain BDs in one packet, for example, the first BD and the last BD, may
need to setup special control information. <b>Descriptor Ring State Machine</b>
There are two states of the BD ring: - HALTED (H), where hardware is not running
- NOT HALTED (NH), where hardware is running The following diagram shows the
state transition for the DMA engine: <pre> _____ XAxiDma_StartBdRingHw(), or
XAxiDma_BdRingStart(), ______ | | or XAxiDma_Resume() | | | H
|---------------------------------------------------| NH | |
|<-----------------------------------------------------| | ----- XAxiDma_Pause()
or XAxiDma_Reset() </pre> <b>Interrupt Coalescing</b> SGDMA provides control
over the frequency of interrupts through interrupt coalescing. The DMA engine
provides two ways to tune the interrupt coalescing: - The packet threshold
counter. Interrupt will fire once the programmable number of packets have been
processed by the engine. - The packet delay timer counter. Interrupt will fire
once the programmable amount of time has passed after processing the last
packet, and no new packets to process. Note that the interrupt will only fire if
at least one packet has been processed. <b> Interrupt </b> Interrupts are
handled by the user application. Each DMA channel has its own interrupt ID. The
driver provides APIs to enable/disable interrupt, and tune the interrupt
frequency regarding to packet processing frequency. <b> Software Initialization
</b> To use the Simple mode DMA engine for transfers, the following setup is
required: - DMA Initialization using XAxiDma_CfgInitialize() function. This step
initializes a driver instance for the given DMA engine and resets the engine. -
Enable interrupts if chosen to use interrupt mode. The application is
responsible for setting up the interrupt system, which includes providing and
connecting interrupt handlers and call back functions, before enabling the
interrupts. - Set the buffer address and length field in respective channels to
start the DMA transfer To use the SG mode DMA engine for transfers, the
following setup are required: - DMA Initialization using XAxiDma_CfgInitialize()
function. This step initializes a driver instance for the given DMA engine and
resets the engine. - BD Ring creation. A BD ring is needed per DMA channel and
can be built by calling XAxiDma_BdRingCreate(). - Enable interrupts if chose to
use interrupt mode. The application is responsible for setting up the interrupt
system, which includes providing and connecting interrupt handlers and call back
functions, before enabling the interrupts. - Start a DMA transfer: Call
XAxiDma_BdRingStart() to start a transfer for the first time or after a reset,
and XAxiDma_BdRingToHw() if the channel is already started. Calling
XAxiDma_BdRingToHw() when a DMA channel is not running will not put the BDs to
the hardware, and the BDs will be processed later when the DMA channel is
started through XAxiDma_BdRingStart(). <b> How to start DMA transactions </b>
The user application uses XAxiDma_BdRingToHw() to submit BDs to the hardware to
start DMA transfers. For both channels, if the DMA engine is currently stopped
(using XAxiDma_Pause()), the newly added BDs will be accepted but not processed
until the DMA engine is started, using XAxiDma_BdRingStart(), or resumed, using
XAxiDma_Resume(). <b> Software Post-Processing on completed DMA transactions
</b> If the interrupt system has been set up and the interrupts are enabled, a
DMA channels notifies the software about the completion of a transfer through
interrupts. Otherwise, the user application can poll for completions of the BDs,
using XAxiDma_BdRingFromHw() or XAxiDma_BdHwCompleted(). - Once BDs are finished
by a channel, the application first needs to fetch them from the channel using
XAxiDma_BdRingFromHw(). - On the TX side, the application now could free the
data buffers attached to those BDs as the data in the buffers has been
transmitted. - On the RX side, the application now could use the received data
in the buffers attached to those BDs. - For both channels, completed BDs need to
be put back to the Free group using XAxiDma_BdRingFree(), so they can be used
for future transactions. - On the RX side, it is the application's
responsibility to have BDs ready to receive data at any time. Otherwise, the RX
channel refuses to accept any data if it has no RX BDs. <b> Examples </b> We
provide five examples to show how to use the driver API: - One for SG interrupt
mode (xaxidma_example_sg_intr.c), multiple BD/packets transfer - One for SG
polling mode (xaxidma_example_sg_poll.c), single BD transfer. - One for SG
polling mode (xaxidma_poll_multi_pkts.c), multiple BD/packets transfer - One for
simple polling mode (xaxidma_example_simple_poll.c) - One for simple Interrupt
mode (xaxidma_example_simple_intr.c) <b> Address Translation </b> All buffer
addresses and BD addresses for the hardware are physical addresses. The user
application is responsible to provide physical buffer address for the BD upon BD
ring creation. The user application accesses BD through its virtual address. The
driver maintains the address translation between the physical and virtual
address for BDs. <b> Cache Coherency </b> This driver expects all application
buffers attached to BDs to be in cache coherent memory. If cache is used in the
system, buffers for transmit MUST be flushed from the cache before passing the
associated BD to this driver. Buffers for receive MUST be invalidated before
accessing the data. <b> Alignment </b> For BDs: Minimum alignment is defined by
the constant XAXIDMA_BD_MINIMUM_ALIGNMENT. This is the smallest alignment
allowed by both hardware and software for them to properly work. If the
descriptor ring is to be placed in cached memory, alignment also MUST be at
least the processor's cache-line size. Otherwise, system instability occurs. For
alignment larger than the cache line size, multiple cache line size alignment is
required. Aside from the initial creation of the descriptor ring (see
XAxiDma_BdRingCreate()), there are no other run-time checks for proper alignment
of BDs. For application data buffers: Application data buffers may reside on any
alignment if DRE is built into the hardware. Otherwise, application data buffer
must be word-aligned. The word is defined by
XPAR_AXIDMA_0_M_AXIS_MM2S_TDATA_WIDTH for transmit and
XPAR_AXIDMA_0_S_AXIS_S2MM_TDATA_WIDTH for receive. For scatter gather transfers
that have more than one BDs in the chain of BDs, Each BD transfer length must be
multiple of word too. Otherwise, internal error happens in the hardware. <b>
Error Handling </b> The DMA engine will halt on all error conditions. It
requires the software to do a reset before it can start process new transfer
requests. <b> Restart After Stopping </b> After the DMA engine has been stopped
(through reset or reset after an error) the software keeps track of the current
BD pointer when reset happens, and processing of BDs can be resumed through
XAxiDma_BdRingStart(). <b> Limitations </b> This driver does not have any
mechanisms for mutual exclusion. It is up to the application to provide this
protection. <b> Hardware Defaults & Exclusive Use </b> After the initialization
or reset, the DMA engine is in the following default mode: - All interrupts are
disabled. - Interrupt coalescing counter is 1. - The DMA engine is not running
(halted). Each DMA channel is started separately, using XAxiDma_StartBdRingHw()
if no BDs are setup for transfer yet, or XAxiDma_BdRingStart() otherwise. The
driver has exclusive use of the registers and BDs. All accesses to the registers
and BDs should go through the driver interface. <b> Debug Print </b> To see the
debug print for the driver, please put "-DDEBUG" as the extra compiler flags in
software platform settings. Also comment out the line in xdebug.h: "undef
DEBUG". <b>Changes From v1.00a</b> . We have changes return type for
XAxiDma_BdSetBufAddr() from void to int . We added XAxiDma_LookupConfig() so
that user does not need to look for the hardware settings anymore. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 05/18/10
First release 2.00a jz 08/10/10 Second release, added in xaxidma_g.c,
xaxidma_sinit.c, updated tcl file, added xaxidma_porting_guide.h 3.00a jz
11/22/10 Support IP core parameters change 4.00a rkv 02/22/11 Added support for
simple DMA mode New API added for simple DMA mode are - XAxiDma_Busy -
XAxiDma_SimpleTransfer New Macros added for simple DMA mode are - XAxiDma_HasSg
- XAxiDma_IntrEnable - XAxiDma_IntrGetEnabled - XAxiDma_IntrDisable -
XAxiDma_IntrGetIrq - XAxiDma_IntrAckIrq 5.00a srt 08/25/11 Added support for
memory barrier and modified Cache Macros to have a common API for Microblaze and
Zynq. 6.00a srt 01/24/12 Added support for Multi-Channel DMA mode. - Changed
APIs: XAxiDma_GetRxRing(InstancePtr, RingIndex) XAxiDma_Start(XAxiDma
InstancePtr, int RingIndex) XAxiDma_Started(XAxiDma InstancePtr, int RingIndex)
XAxiDma_Pause(XAxiDma InstancePtr, int RingIndex) XAxiDma_Resume(XAxiDma
InstancePtr, int RingIndex) XAxiDma_SimpleTransfer(XAxiDma InstancePtr, u32
BuffAddr, u32 Length, int Direction, int RingIndex)
XAxiDma_StartBdRingHw(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingStart(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingToHw(XAxiDma_BdRing RingPtr, int NumBd, XAxiDma_Bd BdSetPtr, int
RingIndex) XAxiDma_BdRingDumpRegs(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingSnapShotCurrBd(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdSetLength(XAxiDma_Bd BdPtr, u32 LenBytes, u32 LengthMask)
XAxiDma_BdGetActualLength(BdPtr, LengthMask) XAxiDma_BdGetLength(BdPtr,
LengthMask) - New APIs XAxiDma_SelectKeyHole(XAxiDma InstancePtr, int Direction,
int Select) XAxiDma_UpdateBdRingCDesc(XAxiDma_BdRing RingPtr, int RingIndex)
7.00a srt 06/18/12 All the APIs changed in v6_00_a are reverted back for
backward compatibility. - New API: XAxiDma_GetRxIndexRing(InstancePtr,
RingIndex) 7.01a srt 10/26/12 - Fixed issue with driver as it fails with IP
version < 6.00a as the parameter C_NUM__CHANNELS is not applicable. - Changed
the logic of MCDMA BD fields Set APIs, to clear the field first and then set it.
7.02a srt 01/23/13 Replaced _TDATA_WIDTH parameters to _DATA_WIDTH (CR 691867)
Updated DDR base address for IPI designs (CR 703656). 8.0 adk 19/12/13 Updated
as per the New Tcl API's srt 01/29/14 Added support for Micro DMA Mode and
cyclic mode of operations. - New APIs: XAxiDma_SelectCyclicMode(XAxiDma
InstancePtr, int Direction, int Select)
XAxiDma_BdSetBufAddrMicroMode(XAxiDma_Bd, u32) 8.1 adk 20/01/15 Added support
for peripheral test. Created the self test example to include it on peripheral
test's(CR823144). 8.1 adk 29/01/15 Added the sefltest api (XAxiDma_Selftest) to
the driver source files (xaxidma_selftest.c) and called this from the selftest
example 9.0 adk 27/07/15 Added support for 64-bit Addressing. 9.0 adk 19/08/15
Fixed CR873125 DMA SG Mode example tests are failing on HW in 2015.3. 9.1 sk
11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. 9.3 adk 26/07/16
Reduce the size of the buffer descriptor to 64 bytes. ms 01/23/17 Modified
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. ms 04/05/17 Modified Comment lines in functions to recognize
it as documentation block and added tabspace at return statements in functions
of axidma examples for proper documentation while generating doxygen. Modified
readme file in examples folder. 9.4 adk 25/07/17 Added example for cyclic dma
mode CR974218. adk 08/08/17 Fixed CR980607 Can't select individual AXI DMA code
examples. Fixed compilation warning in the driver 9.5 adk 17/10/17 Fixed
CR987026 mulit packet example fails on A53. 26/10/17 Fixed CR987214 Fix race
condition in the XAxiDma_Reset(). rsp 11/01/17 Fixed CR988210 Add interface to
do config lookup based on base address. adk 13/11/17 Fixed CR989455 multi-
channel interrupt example fails on A53. 9.6 rsp 01/11/18 Fixed CR976392 In
XAxiDma struct use UINTPTR for RegBase. In XAxiDma_LookupConfigBaseAddr() use
UINTPTR for Baseaddr. 9.7 rsp 04/25/18 Add SgLengthWidth member in dma config
structure. CR 1000474 </pre>

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_bd.c @addtogroup
axidma_v9_9 @{ Buffer descriptor (BD) management API implementation. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 05/18/10
First release 2.00a jz 08/10/10 Second release, added in xaxidma_g.c,
xaxidma_sinit.c, updated tcl file, added xaxidma_porting_guide.h 3.00a jz
11/22/10 Support IP core parameters change 6.00a srt 01/24/12 Added support for
Multi-Channel DMA. - Changed APIs XAxiDma_BdSetLength(XAxiDma_Bd BdPtr, u32
LenBytes, u32 LengthMask) XAxiDma_BdGetActualLength(BdPtr, LengthMask)
XAxiDma_BdGetLength(BdPtr, LengthMask) 8.0 srt 01/29/14 Added support for Micro
DMA Mode: - New API XAxiDma_BdSetBufAddrMicroMode(XAxiDma_Bd, u32) 9.8 mus
11/05/18 Support 64 bit DMA addresses for Microblaze-X </pre> /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_bd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_bd.h @addtogroup
axidma_v9_9 @{ Buffer descriptor (BD) management API. <b> Buffer Descriptors
</b> A BD defines a DMA transaction (see "Transaction" section in xaxidma.h).
All accesses to a BD go through this set of API. The XAxiDma_Bd structure
defines a BD. The first XAXIDMA_BD_HW_NUM_BYTES are shared between hardware and
software. <b> Actual Transfer Length </b> The actual transfer length for receive
could be smaller than the requested transfer length. The hardware sets the
actual transfer length in the completed BD. The API to retrieve the actual
transfer length is XAxiDma_GetActualLength(). <b> User IP words </b> There are 5
user IP words in each BD. If hardware does not have the StsCntrl stream built
in, then these words are not usable. Retrieving these words get a NULL pointer
and setting these words results an error. <b> Performance </b> BDs are typically
in a non-cached memory space. Reducing the number of I/O operations to BDs can
improve overall performance of the DMA channel. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a jz 05/18/10 First release 2.00a jz
08/10/10 Second release, added in xaxidma_g.c, xaxidma_sinit.c, updated tcl
file, added xaxidma_porting_guide.h 3.00a jz 11/22/10 Support IP core parameters
change 5.00a srt 08/25/11 Changed Cache Macros to have a common API for Zynq and
Microblaze. 6.00a srt 01/24/12 Added APIs to support Multi-Channel DMA:
XAxiDma_BdSetTId() XAxiDma_BdGetTId() XAxiDma_BdSetTDest() XAxiDma_BdGetTDest()
XAxiDma_BdSetTUser() XAxiDma_BdGetTUser() XAxiDma_BdSetARCache()
XAxiDma_BdGetARCache() XAxiDma_BdSetARUser() XAxiDma_BdGetARUser()
XAxiDma_BdSetStride() XAxiDma_BdGetStride() XAxiDma_BdSetVSize()
XAxiDma_BdGetVSize() - Changed APIs XAxiDma_BdGetActualLength(BdPtr, LengthMask)
XAxiDma_BdGetLength(BdPtr, LengthMask) XAxiDma_BdSetLength(XAxiDma_Bd BdPtr, u32
LenBytes, u32 LengthMask) 7.01a srt 10/26/12 Changed the logic of MCDMA BD
fields Set APIs, to clear the field first and set it. 8.0 srt 01/29/14 Added
support for Micro DMA Mode. 9.2 vak 15/04/16 Fixed compilation warnings in
axidma driver 9.8 rsp 07/11/18 Fix cppcheck portability warnings. CR 1006164
</pre> /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_bd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_bdring.c @addtogroup
axidma_v9_9 @{ This file implements buffer descriptor ring related functions.
For more information on how to manage the BD ring, please see xaxidma.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 05/18/10
First release 2.00a jz 08/10/10 Second release, added in xaxidma_g.c,
xaxidma_sinit.c, updated tcl file, added xaxidma_porting_guide.h 3.00a jz
11/22/10 Support IP core parameters change 5.00a srt 08/25/11 Added support for
memory barrier. 6.00a srt 01/24/12 Added support for Multi-Channel DMA. - New
API XAxiDma_UpdateBdRingCDesc(XAxiDma_BdRing RingPtr, int RingIndex) - Changed
APIs XAxiDma_StartBdRingHw(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingStart(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingToHw(XAxiDma_BdRing RingPtr, int NumBd, XAxiDma_Bd BdSetPtr, int
RingIndex) XAxiDma_BdRingDumpRegs(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingSnapShotCurrBd(XAxiDma_BdRing RingPtr, int RingIndex) 7.00a srt
06/18/12 All the APIs changed in v6_00_a are reverted back for backward
compatibility. 9.6 rsp 01/11/18 Use UINTPTR for all RegBase instances CR976392
rsp 01/17/18 Use virtual address for register read/write. In _BdRingCreate()
assign VA to BdaRestart CR976392 9.9 rsp 02/05/19 Fix XAxiDma_BdRingFromHw
implementation for cyclic mode. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_bdring.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_bdring.h @addtogroup
axidma_v9_9 @{ This file contains DMA channel related structure and constant
definition as well as function prototypes. Each DMA channel is managed by a
Buffer Descriptor ring, and XAxiDma_BdRing is chosen as the symbol prefix used
in this file. See xaxidma.h for more information on how a BD ring is managed.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz
05/18/10 First release 2.00a jz 08/10/10 Second release, added in xaxidma_g.c,
xaxidma_sinit.c, updated tcl file, added xaxidma_porting_guide.h 3.00a jz
11/22/10 Support IP core parameters change 6.00a srt 01/24/12 Added support for
Multi-Channel DMA. - New API XAxiDma_UpdateBdRingCDesc(XAxiDma_BdRing RingPtr,
int RingIndex) - Changed APIs XAxiDma_StartBdRingHw(XAxiDma_BdRing RingPtr, int
RingIndex) XAxiDma_BdRingStart(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingToHw(XAxiDma_BdRing RingPtr, int NumBd, XAxiDma_Bd BdSetPtr, int
RingIndex) XAxiDma_BdRingDumpRegs(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingSnapShotCurrBd(XAxiDma_BdRing RingPtr, int RingIndex) 7.00a srt
06/18/12 All the APIs changed in v6_00_a are reverted back for backward
compatibility. 9.2 vak 15/04/16 Fixed the compilation warnings in axidma driver
9.7 rsp 01/11/18 Use UINTPTR instead of u32 for ChanBase CR976392 </pre>

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_bdring.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_g.c @addtogroup
axidma_v9_9 @{ Provide a template for user to define their own hardware
settings. If using XPS, then XPS will automatically generate this file. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 08/16/10
First release 2.00a jz 08/10/10 Second release, added in xaxidma_g.c,
xaxidma_sinit.c, updated tcl file, added xaxidma_porting_guide.h 3.00a jz
11/22/10 Support IP core parameters change 4.00a rkv 02/22/11 Added support for
simple DMA mode 6.00a srt 01/24/12 Added support for Multi-Channel DMA mode
7.02a srt 01/23/13 Replaced _TDATA_WIDTH parameters to _DATA_WIDTH (CR 691867)
9.7 rsp 04/25/18 In XAxiDma_Config add SG length width. 9.8 rsp 07/18/18 Sync
XAxiDma_Config initializer fields </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_hw.h @addtogroup
axidma_v9_9 @{ Hardware definition file. It defines the register interface and
Buffer Descriptor (BD) definitions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a jz 05/18/10 First release 2.00a jz 08/10/10
Second release, added in xaxidma_g.c, xaxidma_sinit.c, updated tcl file, added
xaxidma_porting_guide.h 3.00a jz 11/22/10 Support IP core parameters change
4.00a rkv 02/22/11 Added support for simple DMA mode 6.00a srt 01/24/12 Added
support for Multi-Channel DMA mode 8.0 srt 01/29/14 Added support for Micro DMA
Mode and Cyclic mode of operations. 9.7 rsp 04/24/18 Added support for 64MB data
transfer.Instead of define read max buffer width from IP config. </pre> /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_porting_guide.h
@addtogroup axidma_v9_9 @{ This is a guide on how to move from using the xlldma
driver to use xaxidma driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jz 05/18/10 First release 2.00a jz 08/10/10 Second
release, added in xaxidma_g.c, xaxidma_sinit.c, updated tcl file, added
xaxidma_porting_guide.h 4.00a rkv 02/22/11 Added support for simple DMA mode
6.00a srt 03/27/12 Added support for MCDMA mode 7.00a srt 06/18/12 API calls are
reverted back for backward compatibility. </pre> <b>Overview</b> The API for
xaxidma driver is similar to xlldma driver. The prefix for the API functions and
structures is XAxiDma_ for the xaxidma driver. Due to hardware feature changes,
signatures of some API functions are a little bit different from the xlldma API
functions. We present API functions: - That only have prefix changes - That have
different return type - That are new API functions - That have been removed Note
that data structures have different prefix of XAxiDma_. Those API functions,
that have data structures with prefix change, are considered as prefix change.
<b>API Functions That Only Have Prefix Changes</b> <pre> xlldma driver | xaxidma
driver (up to v5_00_a) XLlDma_Reset(...) | XAxiDma_Reset(...)
XLlDma_BdRingSnapShotCurrBd(...)| XAxiDma_BdRingSnapShotCurrBd(...)
XLlDma_BdRingNext(...) | XAxiDma_BdRingNext(...) XLlDma_BdRingPrev(...) |
XAxiDma_BdRingPrev(...) XLlDma_BdRingGetSr(...) | XAxiDma_BdRingGetSr(...)
XLlDma_BdRingBusy(...) | XAxiDma_BdRingBusy(...) XLlDma_BdRingIntEnable(...) |
XAxiDma_BdRingIntEnable(...) XLlDma_BdRingIntDisable(...) |
XAxiDma_BdRingIntDisable(...) XLlDma_BdRingIntGetEnabled(...) |
XAxiDma_BdRingIntGetEnabled(...) XLlDma_BdRingGetIrq(...) |
XAxiDma_BdRingGetIrq(...) XLlDma_BdRingAckIrq(...) | XAxiDma_BdRingAckIrq(...)
XLlDma_BdRingCreate(...) | XAxiDma_BdRingCreate(...) XLlDma_BdRingClone(...) |
XAxiDma_BdRingClone(...) XLlDma_BdRingAlloc(...) | XAxiDma_BdRingAlloc(...)
XLlDma_BdRingUnAlloc(...) | XAxiDma_BdRingUnAlloc(...) XLlDma_BdRingToHw(...) |
XAxiDma_BdRingToHw(...) XLlDma_BdRingFromHw(...) | XAxiDma_BdRingFromHw(...)
XLlDma_BdRingFree(...) | XAxiDma_BdRingFree(...) XLlDma_BdRingStart(...) |
XAxiDma_BdRingStart(...) XLlDma_BdRingCheck(...) | XAxiDma_BdRingCheck(...)
XLlDma_BdRingSetCoalesce(...) | XAxiDma_BdRingSetCoalesce(...)
XLlDma_BdRingGetCoalesce(...) | XAxiDma_BdRingGetCoalesce(...)
XLlDma_BdRead(...) | XAxiDma_BdRead(...) XLlDma_BdWrite(...) |
XAxiDma_BdWrite(...) XLlDma_BdClear(...) | XAxiDma_BdClear(...)
XLlDma_BdSetId(...) | XAxiDma_BdSetId(...) XLlDma_BdGetId(...) |
XAxiDma_BdGetId(...) XLlDma_BdGetLength(...) | XAxiDma_BdGetLength(...)
XLlDma_BdGetBufAddr(...) | XAxiDma_BdGetBufAddr(...) </pre> <b>API Functions
That Have Different Return Type</b> Due to possible hardware failures, The
caller should check the return value of the following functions. <pre> xlldma
driver | xaxidma driver void XLlDma_Pause(...) | int XAxiDma_Pause(...) void
XLlDma_Resume(...) | int XAxiDma_Resume(...) </pre> The following functions have
return type changed: <pre> xlldma driver | xaxidma driver XLlDma_BdRing
XLlDma_GetRxRing(...)| XAxiDma_BdRing XAxiDma_GetRxRing(...) XLlDma_BdRing
XLlDma_GetTxRing(...)| XAxiDma_BdRing XAxiDma_GetTxRing(...) u32
XLlDma_BdRingMemCalc(...) | int XAxiDma_BdRingMemCalc(...) u32
XLlDma_BdRingCntCalc(...) | int XAxiDma_BdRingCntCalc(...) u32
XLlDma_BdRingGetCnt(...) | int XAxiDma_BdRingGetCnt(...) u32
XLlDma_BdRingGetFreeCnt(...) | int XAxiDma_BdRingGetFreeCnt(...) void
XLlDma_BdSetLength(...) | int XAxiDma_BdSetLength(...) void
XLlDma_BdSetBufAddr(...) | int XAxiDma_BdSetBufAddr(...) </pre> <b>API Functions
That Are New API Functions</b> Now that the AXI DMA core is a standalone core,
some new API are introduced. Some other functions are added due to hardware
interface change, so to replace old API functions. - XAxiDma_Config
XAxiDma_LookupConfig(u32 DeviceId); - int XAxiDma_CfgInitialize(XAxiDma
InstancePtr, XAxiDma_Config Config); - int XAxiDma_ResetIsDone(XAxiDma
InstancePtr); - XAxiDma_Bd XAxiDma_BdRingGetCurrBd(XAxiDma_BdRing RingPtr); -
int XAxiDma_BdRingHwIsStarted(XAxiDma_BdRing RingPtr); - void
XAxiDma_BdRingDumpRegs(XAxiDma_BdRing RingPtr); - int
XAxiDma_StartBdRingHw(XAxiDma_BdRing RingPtr); - void
XAxiDma_BdSetCtrl(XAxiDma_Bd BdPtr, u32 Data); - u32
XAxiDma_BdGetCtrl(XAxiDma_Bd BdPtr); - u32 XAxiDma_BdGetSts(XAxiDma_Bd BdPtr); -
int XAxiDma_BdHwCompleted(XAxiDma_Bd BdPtr); - int
XAxiDma_BdGetActualLength(XAxiDma_Bd BdPtr); - int
XAxiDma_BdSetAppWord(XAxiDma_Bd BdPtr, int Offset, u32 Word); - u32
XAxiDma_BdGetAppWord(XAxiDma_Bd BdPtr, int Offset, int Valid); <b>API Functions
That Have Been Removed</b> Please see individual function comments for how to
replace the removed API function with new API functions. - void
XLlDma_Initialize(XLlDma InstancePtr, u32 BaseAddress). This function is
replaced by XAxiDma_LookupConfig()/XAxiDma_CfgInitialize() - u32
XLlDma_BdRingGetCr(XLlDma_BdRing RingPtr). This is replaced by
XAxiDma_BdRingGetError(XAxiDma_BdRing RingPtr) - u32
XLlDma_BdRingSetCr(XLlDma_BdRing RingPtr, u32 Data). This function is covered by
other API functions: - void XAxiDma_BdRingIntEnable(XAxiDma_BdRing RingPtr, u32
Mask) - void XAxiDma_BdRingIntDisable(XAxiDma_BdRing RingPtr, u32 Mask) - int
XAxiDma_BdRingSetCoalesce(XAxiDma_BdRing RingPtr, u32 Counter, u32 Timer) - u32
XLlDma_BdSetStsCtrl(XLlDma_Bd BdPtr, u32 Data). Replaced by
XAxiDma_BdSetCtrl(XAxiDma_Bd BdPtr, u32 Data); - u32
XLlDma_BdGetStsCtrl(XLlDma_Bd BdPtr). Replaced by XAxiDma_BdGetCtrl(XAxiDma_Bd
BdPtr) and XAxiDma_BdGetSts(XAxiDma_Bd BdPtr). <b>API Functions That Have Been
Added to support simple DMA mode</b> - u32 XAxiDma_Busy(XAxiDma InstancePtr,int
Direction); - int XAxiDma_SimpleTransfer(XAxiDma InstancePtr, u32 BuffAddr, int
Length, int Direction); - XAxiDma_HasSg(InstancePtr); -
XAxiDma_IntrEnable(InstancePtr,Mask,Direction); -
XAxiDma_IntrGetEnabled(InstancePtr, Direction); -
XAxiDma_IntrDisable(InstancePtr, Mask, Direction); -
XAxiDma_IntrGetIrq(InstancePtr, Direction); - XAxiDma_IntrAckIrq(InstancePtr,
Mask, Direction); <b> For xaxidma driver v6_00_a Multiple Channel Support This
driver supports Multi-channel mode and accordingly some APIs are changed to
index multiple channels. Few new APIs are added. - Changed APIs
XAxiDma_GetRxRing(InstancePtr, RingIndex) XAxiDma_Start(XAxiDma InstancePtr, int
RingIndex) XAxiDma_Started(XAxiDma InstancePtr, int RingIndex)
XAxiDma_Pause(XAxiDma InstancePtr, int RingIndex) XAxiDma_Resume(XAxiDma
InstancePtr, int RingIndex) XAxiDma_SimpleTransfer(XAxiDma InstancePtr, u32
BuffAddr, u32 Length, int Direction, int RingIndex)
XAxiDma_StartBdRingHw(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingStart(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingToHw(XAxiDma_BdRing RingPtr, int NumBd, XAxiDma_Bd BdSetPtr, int
RingIndex) XAxiDma_BdRingDumpRegs(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdRingSnapShotCurrBd(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdSetLength(XAxiDma_Bd BdPtr, u32 LenBytes, u32 LengthMask)
XAxiDma_BdGetActualLength(BdPtr, LengthMask) XAxiDma_BdGetLength(BdPtr,
LengthMask) - New APIs XAxiDma_SelectKeyHole(XAxiDma InstancePtr, int Direction,
int Select) XAxiDma_UpdateBdRingCDesc(XAxiDma_BdRing RingPtr, int RingIndex)
XAxiDma_BdSetTId() XAxiDma_BdGetTId() XAxiDma_BdSetTDest() XAxiDma_BdGetTDest()
XAxiDma_BdSetTUser() XAxiDma_BdGetTUser() XAxiDma_BdSetARCache()
XAxiDma_BdGetARCache() XAxiDma_BdSetARUser() XAxiDma_BdGetARUser()
XAxiDma_BdSetStride() XAxiDma_BdGetStride() XAxiDma_BdSetVSize()
XAxiDma_BdGetVSize() <b> For xaxidma driver v7_00_a - New API
XAxiDma_GetRxIndexRing(InstancePtr, RingIndex) - Changed APIs All the APIs
changed in v6_00_a are reverted back for backward compatibility. </pre> @} /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_porting_guide.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_selftest.c @addtogroup
axidma_v9_9 @{ Contains diagnostic/self-test functions for the XAxiDma
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
8.1 adk 29/01/15 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxidma_sinit.c @addtogroup
axidma_v9_9 @{ Look up the hardware settings using device ID. The hardware
setting is inside the configuration table in xaxidma_g.c, generated
automatically by XPS or manually by the user. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a jz 08/16/10 First release 2.00a jz
08/10/10 Second release, added in xaxidma_g.c, xaxidma_sinit.c, updated tcl
file, added xaxidma_porting_guide.h 3.00a jz 11/22/10 Support IP core parameters
change 5.00a srt 08/29/11 Removed a compiler warning 9.5 rsp 11/01/17 Add
interface to do config lookup based on base address. 9.6 rsp 01/11/18 In
LookupConfig use UINTPTR for Baseaddr CR976392 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axidma/src/xaxidma_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: 05/12/10 asa
First Release 02/01/13 srt Added support for IPI designs (CR 698249)

FILES:
XilinxProcessorIPLib/drivers/axiethernet/data/axiethernet.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: 05/12/10 asa
First Release based on the LL TEMAC driver tcl 01/07/13 srt Added C_PHYADDR
configuration parameter to support SGMII mode 02/03/13 srt Added support for IPI
designs (CR 698249) 02/14/13 srt Added support for Zynq (CR 681136) 04/24/13 srt
Modified parameter _SGMII_PHYADDR to _PHYADDR, the config parameter C_PHYADDR
applies to SGMII/1000BaseX modes of operation (CR 704195) 08/06/13 srt Added
support to handle multiple instances of AxiEthernet FIFO interface (CR 721141)
06/08/14 adk Modified the driver tcl to handle the open/close of files properly
(CR 810643) 29/10/14 adk Added support for generating parameters for
SGMII/1000BaseX modes When IP is configured with the PCS/PMA core (CR 828796)
8/1/15 adk Fixed TCL errors when axiethernet is configured with the Axi stream
fifo (CR 835605). 13/06/15 adk Updated the driver tcl for Hier IP(To support
User parameters). 11/09/15 sk Removed delete filename statement CR 784758.
04/18/17 ms Modified tcl file to add suffix U for all macros definitions of
axietherent in xparameters.h 03/07/17 adk Fixed issue lwip stops working as soon
as something is plugged to it's AXI stream buf(CR979634). 01/09/18 rsp Added
support for C_Number_of_Table_Entries parameter. 08/31/18 rsp Improve error
message when ethernet AXI4-Stream is connected to non-supported IP. 09/01/18 rsp
Fixed interrupt ID generation for ZynqMP designs. 10/31/18 rsp Use identifiable
suffix for global variables to avoid conflicts. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/axiethernet/data/axiethernet.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.00.a asa 05/12/10 First Release 4.0 adk
10/12/13 Updated as per the New Tcl API's 4.1 adk 21/4/14 Fixed the CR:780537
Modified the get_dma_info proc logic as appropriate(In case of multiple dma's in
the system some connected to ethernet some not). Software Project Types
(swproj): 0 : MemoryTest - Calls basic memorytest routines from common driver
dir 1 : PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/axiethernet/data/axiethernet_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_example.h Defines
common data types, prototypes, and includes the proper headers for use with the
Axi Ethernet example code residing in this directory. This file along with
xaxiethernet_example_util.c are utilized with the specific example code in the
other source code files provided. These examples are designed to be compiled and
utilized within the EDK standalone BSP development environment. The readme file
contains more information on build requirements needed by these examples. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa 4/30/10
First release based on the ll temac driver 3.02a srt 4/26/13 Added function
prototype for _ConfigureInternalPhy(). </pre>

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxiethernet_example_extmulticast.c Implements examples that utilize the AXI
Ethernet's interrupt driven DMA packet transfer mode to send and receive
multicast frames when XAE_EXT_MULTICAST_OPTION is enabled. This example
demonstrates: - How to perform option enable - Which interrupt BD word are
verified and confirm it is a valid multicast frame. Functional guide to example:
- AxiEthernetSgDmaIntrExtMulticast Example demonstrates the extended multicast.
The HW must be setup for extended multicast for this example to execute. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa 4/30/10
First release based on the ll temac driver 1.01a asa 12/10/10 Changes made to
enable the AXIDMA Tx/Rx ring interrupts before allocation of Tx/Rx BDs. 3.00a
asa 6/25/12 Modified XAxiDma_BdSetLength API call to support new AXI DMA driver
version 7.00a. 3.00a bss 10/22/12 Added support for Fast Interrupt Handlers.
3.01a srt 02/14/13 Added support for Zynq (CR 681136) 5.4 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. 5.7 rsp 19/12/17 Defined Padding and
ExternalLoopback variables. </pre>

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_extmulticast.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_example_extvlan.c
Implements examples that utilize the Axi Ethernet's interrupt driven SGDMA
packet transfer mode to send and receive frames. This example demonstrates: -
How to setup VLAN strip/translate/tag in TX and RX direction - How the VLAN tags
are handled - What is the expected VLAN tag(s) after VLAN functions are invoked
Functional guide to example: - AxiEthernetSgDmaIntrExtVlanExample demonstrates
the extended VLAN capability. The HW must be setup for extended VLAN for this
example to execute. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a asa 4/30/10 First release based on the ll temac driver 1.01a asa
12/10/10 Changes made to enable the AXIDMA Tx/Rx ring interrupts before
allocation of Tx/Rx BDs. 3.00a asa 6/25/12 Modified XAxiDma_BdSetLength API call
to support new AXI DMA driver version 7.00a. 3.00a bss 10/22/12 Added support
for Fast Interrupt Handlers. 3.01a srt 02/14/13 Added support for Zynq (CR
681136) 5.4 ms 01/23/17 Modified xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. ms 04/05/17 Added tabspace for return statements in
functions for proper documentation while generating doxygen. 5.7 rsp 19/12/17
Defined Padding and ExternalLoopback variables. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_extvlan.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxiethernet_example_intr_fifo.c Implements examples that utilize the Axi
Ethernet's interrupt driven FIFO direct packet transfer mode to send and receive
frames. These examples demonstrate: - How to perform simple send and receive. -
Advanced frame processing - Error handling - Device reset Functional guide to
example: - AxiEthernetSingleFrameIntrExample() demonstrates the simplest way to
send and receive frames in interrupt driven FIFO direct mode. -
AxiEthernetSingleFrameNonContIntrExample demonstrates how to handle frames that
are stored in more than one memory location. -
AxiEthernetMultipleFramesIntrExample demonstrates how to defer frame reception
so that CPU intensive receive functions are not performed in interrupt context.
- AxiEthernetErrorHandler() demonstrates how to manage asynchronous errors. -
AxiEthernetResetDevice() demonstrates how to reset the driver/HW while
maintaining driver/HW state. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a asa 4/30/10 First release based on the ll temac driver
3.00a bss 10/22/12 Added support for Fast Interrupt Handlers. 3.01a srt 02/14/13
Added support for Zynq (CR 681136) 3.02a srt 08/06/13 Fixed CR 727634 Modified
FifoHandler() logic to reflect the bit changes in the Interrupt Status Register
as per the latest AXI FIFO stream IP. 5.4 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Added return tags in functions for proper documentation while generating
doxygen. 5.6 adk 03/07/17 Fixed CR979023 Example failed to compile. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_intr_fifo.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxiethernet_example_intr_mcdma.c Implements examples that utilize the Axi
Ethernet's interrupt driven MCDMA packet transfer mode to send and receive
frames. These examples demonstrate: - How to perform simple send and receive -
Checksum offload - Error handling - Device reset - How to perform multiple
frames send and receive Functional guide to example: -
AxiEthernetSgDmaIntrSingleFrameExample demonstrates the simplest way to send and
receive frames in interrupt driven mode. - AxiEthernetSgDmaIntrMultiFrameExample
demonstrates the way to send and recv Multiple frames in polling mode. -
AxiEthernetSgDmaPartialChecksumOffloadExample demonstrates the partial checksum
offloading. The HW must be setup for partial checksum offloading for this
example to execute. - AxiEthernetSgDmaFullChecksumOffloadExample demonstrates
the full checksum offloading. The HW must be setup for full checksum offloading
for this example to execute. - AxiEthernetAxiEthernetErrorHandler() demonstrates
how to manage asynchronous errors. - AxiEthernetResetDevice() demonstrates how
to reset the driver/HW without losing all configuration settings. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.5 adk Initial
Release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_intr_mcdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxiethernet_example_intr_sgdma.c Implements examples that utilize the Axi
Ethernet's interrupt driven SGDMA packet transfer mode to send and receive
frames. These examples demonstrate: - How to perform simple send and receive -
Interrupt coalescing - Checksum offload - Error handling - Device reset
Functional guide to example: - AxiEthernetSgDmaIntrSingleFrameExample
demonstrates the simplest way to send and receive frames in in interrupt driven
SGDMA mode. - AxiEthernetSgDmaIntrCoalescingExample demonstrates how to use
interrupt coalescing to increase throughput. -
AxiEthernetSgDmaPartialChecksumOffloadExample demonstrates the partial checksum
offloading. The HW must be setup for partial checksum offloading for this
example to execute. - AxiEthernetSgDmaFullChecksumOffloadExample demonstrates
the full checksum offloading. The HW must be setup for full checksum offloading
for this example to execute. - AxiEthernetAxiEthernetErrorHandler() demonstrates
how to manage asynchronous errors. - AxiEthernetResetDevice() demonstrates how
to reset the driver/HW without losing all configuration settings. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa 4/30/10
First release based on the ll temac driver 1.01a asa 12/10/10 Added full
checksum offload example. Changes made to enable the AXIDMA Tx/Rx ring
interrupts before allocation of Tx/Rx BDs for all examples. 3.00a asa 6/25/12
Modified XAxiDma_BdSetLength API call to support new AXI DMA driver version
7.00a. Removed the calls to XAxiDma_BdRingStart for the coalesce and checksum
offload examples. They are not required with the new AxiDMA version. 3.00a bss
10/22/12 Added support for Fast Interrupt Handlers. 3.01a srt 02/14/13 Added
support for Zynq (CR 681136). 5.4 ms 01/23/17 Modified xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. ms 04/05/17 Added
tabspace for return statements in functions for proper documentation while
generating doxygen. 5.8 rsp 07/23/18 Fix gcc '[-Wint-conversion]' warning. rsp
10/22/18 Set RX BD length to jumbo frame size. It fixes 'Error committing RxBD
to HW' error for designs having length register width < 19 bits. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_intr_sgdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxiethernet_example_mcdma_poll.c Implements examples that utilize the Axi
Ethernet's polled mode MCDMA packet transfer mode to send and receive frames.
These examples demonstrate: - How to perform simple send and receive - Checksum
offload - How to perform multiple frames send and receive Functional guide to
example: - AxiEthernetSgDmaSingleFrameExample demonstrates the simplest way to
send and receive frames in polling mode. -
AxiEthernetSgDmaPartialChecksumOffloadExample demonstrates the partial checksum
offloading. The HW must be setup for partial checksum offloading for this
example to execute. - AxiEthernetSgDmaFullChecksumOffloadExample demonstrates
the full checksum offloading. The HW must be setup for full checksum offloading
for this example to execute. - AxiEthernetSgDmaMultiFrameExample demonstrates
the way to send and recv Multiple frames in polling mode. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 5.5 adk Initial Release.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_mcdma_poll.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_example_polled.c
Implements examples that utilize the Axi Ethernet's FIFO direct frame transfer
mode in a polled fashion to send and receive frames. These examples demonstrate:
- How to perform simple polling send and receive. - Advanced frame processing -
Error handling Functional guide to example: -
AxiEthernetSingleFramePolledExample() demonstrates the simplest way to send and
receive frames in polled mode. - AxiEthernetMultipleFramesPolledExample()
demonstrates how to transmit a "burst" of frames by queueing up several in the
packet FIFO prior to transmission. - AxiEthernetPollForTxStatus() demonstrates
how to poll for transmit complete status and how to handle error conditions. -
AxiEthernetPollForRxStatus() demonstrates how to poll for receive status and how
to handle error conditions. - AxiEthernetResetDevice() demonstrates how to reset
the driver/HW without losing all configuration settings. Note that the advanced
frame processing algorithms shown here are not limited to polled mode operation.
The same techniques can be used for FIFO direct interrupt driven mode as well.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa
4/30/10 First release based on the ll temac driver 5.4 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_polled.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_example_util.c
This file implements the utility functions for the Axi Ethernet example code.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa
6/30/10 First release based on the ll temac driver 3.01a srt 02/03/13 Added
support for SGMII mode (CR 676793). 02/14/13 Added support for Zynq (CR 681136).
3.02a srt 04/24/13 Modified parameter _SGMII_PHYADDR to _PHYADDR, the config
parameter C_PHYADDR applies to SGMII/1000BaseX modes of operation and added
support for 1000BaseX mode (CR 704195). Added function _ConfigureInternalPhy()
for this purpose. 04/24/13 Added support for RGMII mode. 3.02a srt 08/06/13
Fixed CR 717949: Configures external Marvel 88E1111 PHY based on the axi
ethernet physical interface type and allows to operate in specific interface
mode without changing jumpers on the Microblaze board. 5.4 adk 07/12/16 Added
Support for TI PHY DP83867. ms 04/05/17 Added tabspace for return statements in
functions for proper documentation while generating doxygen. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_example_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xaxiethernet_mcdma_ping_req_example.c This file contains a Axi Ethernet MCDMA
Ping request example in polled mode. This example will generate a ping request
for the specified IP address. @note The local IP address is set to 10.10.70.6.
User needs to update LocalIpAddr variable with a free IP address based on the
network on which this example is to be run. The Destination IP address is set to
10.10.70.3. User needs to update DestIpAddress variable with any valid IP
address based on the network on which this example is to be run. The local MAC
address is set to 0x000A35030201. User can update LocalMacAddr variable with a
valid MAC address. The first three bytes contains the manufacture ID. 0x000A35
is XILINX manufacture ID. This program will generate the specified number of
ping request packets as defined in "NUM_OF_PING_REQ_PKTS". This example got
validated only for SGMII based design's. Functional guide to example: -
SendArpReqFrame demonstrates the way to send the ARP request packets in the
polling mode - SendEchoReqFrame demonstrates the way to send the ICMP/ECHO
request packets in the polling mode - ProcessRecvFrame demonstrates the way to
process the received packet. This function sends the echo request packet based
on the ARP reply packet. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 5.5 adk Initial Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/xaxiethernet_mcdma_ping_req_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb.c The top level c file for
the AVB driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a mbr 09/19/08 First release 1.01a mbr 06/24/09 PTP frame format
updates for IEEE802.1 AS draft 5-0 2_02a mbr 09/16/09 Updates for programmable
PTP timers 2_04a kag 07/23/10 PTP frame format updates for IEEE802.1 AS draft
6-7 3_01a kag 08/29/11 Added new APIs to update the RX Filter Control Reg. Fix
for CR:572539. Updated bit map for Rx Filter control reg. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb.h This header file
contains the identifiers and basic driver functions (or macros) that can be used
to access the device. Other driver functions are defined in xavb.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a mbr
09/19/08 First release 1.01a mbr 06/24/09 PTP frame format updates for IEEE802.1
AS draft 5-0 2_02a mbr 09/16/09 Updates for programmable PTP timers 2_04a kag
07/23/10 PTP frame format updates for IEEE802.1 AS draft 6-7 3_01a kag 08/29/11
Added new APIs to update the RX Filter Control Reg. Fix for CR:572539. Updated
bit map for Rx Filter control reg. 4_0 asa 03/06/14 Fix for CR 740863. The value
of XAVB_CLOCK_LOCK_THRESHOLD is increased to 1000ns (1 us) to make it more
meningful and reasonable. </pre>

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb_example.c This file
implements a simple example to show the usage of Audio Video Bridging (AVB)
functionality of Axi Ethernet IP in loopback mode. The example uses the PTP
Timer and the PTP Rx interrupts. A PDelay_Req packet is sent and is received
back (as we are in loopback mode). . After this loop backed PDelay_Req packet is
received, a PDelay_Resp and PDelay_RespFollowUp packets are sent. These packets
are also received. Since the source port identity of the received packets
matches with our systems's own source port identity there is no further
processing done. @note This code assumes the processor type is Microblaze,
Xilinx interrupt controller (XIntc) is used in the system , and that no
operating system is used. It also assumes that all the relevant AVB interrupts
are properly connected to the Intc module. The Ethernet AVB Endpoint
functionality should be enabled in the Xilinx Axi Ethernet core for this example
to work. The Axi Ethernet is used with a GMII interface. The example initializes
the GMII interface with 1000 Mbps speed. IMPORTANT NOTE: The user must define
the macro XAVB_CLOCK_LOCK_THRESHOLD in xavb.h to an appropriate value as
relevant for the corresponding use case. Presently it is defined to 1000 ns
which is typical for telecom industry. This macro is used to compare against the
slave error as calculated every time after receiving 2 successive sync/followup
frames. Slave error is the difference between master time duration and slave
time duration as calculated for the time gap (the time it takes to receive two
successive sync/follow up frames). If slave error is greater than the value
defined in XAVB_CLOCK_LOCK_THRESHOLD, then master and slave clocks are unlocked.
This means the node running this SW assumes that the peer is no more capable of
processing 802.1as frames. The node running the SW then waits till it successful
calculates the path delay (which essentially means the peer is again capable of
processing 802.1as frames. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------- -------- 1.00a kag/asa 08/25/10 First release 3.00a asa 04/10/12
Disabled enabling of promiscuous mode. This is required for AxiEthernet cores
with version v3_01_a onwards because of a change in the AVB implementation. 4.0
asa 03/06/14 Fix for CR 740863. Added a warning message for users of this
example to take note of the fact that we have just used a typical value for
XAVB_CLOCK_LOCK_THRESHOLD and users may want to change it as per their
requirements. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb_hw.c The xavb_hw driver.
Functions in this file are the minimum required functions for this driver. See
xavb_hw.h for a detailed description of the driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a mbr 09/19/08 First release 1.01a
mbr 06/24/09 PTP frame format updates for IEEE802.1 AS draft 5-0 2_02a mbr
09/16/09 Updates for programmable PTP timers 2_04a kag 07/23/10 PTP frame format
updates for IEEE802.1 AS draft 6-7 3_01a kag 08/29/11 Added new APIs to update
the RX Filter Control Reg. Fix for CR:572539. Updated bit map for Rx Filter
control reg. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb_hw.h This header file
contains the identifiers and basic driver functions (or macros) that can be used
to access the device. Other driver functions are defined in xavb.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a mbr
09/19/08 First release 1.01a mbr 06/24/09 PTP frame format updates for IEEE802.1
AS draft 5-0 2_02a mbr 09/16/09 Updates for programmable PTP timers 2_04a kag
07/23/10 PTP frame format updates for IEEE802.1 AS draft 6-7 3_01a kag 08/29/11
Added new APIs to update the RX Filter Control Reg. Fix for CR:572539. Updated
bit map for Rx Filter control reg. 3_01a asa 04/10/12 The AVB core is now
brought inside the AxiEthernet core. Because of this there are changes in the
register map. </pre>

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb_ptp_bmca.c The XAvb
driver. Functions in this file all relate to the Best Master Clock Algorithm
(BMCA) which is performed on the AVB network to select a network Grand Master
Clock. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a mbr 09/19/08 First release 1.01a mbr 06/24/09 PTP frame format updates for
IEEE802.1 AS draft 5-0 2_02a mbr 09/16/09 Updates for programmable PTP timers
2_04a kag 07/23/10 PTP frame format updates for IEEE802.1 AS draft 6-7 3_01a kag
08/29/11 Added new APIs to update the RX Filter Control Reg. Fix for CR:572539.
Updated bit map for Rx Filter control reg. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb_ptp_bmca.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb_ptp_packets.c The XAvb
driver. Functions in this file all contain functions which decode the received
Precise Timing Protocol (PTP) frames, or to format and transmit PTP frames.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a mbr
09/19/08 First release 1.01a mbr 06/24/09 PTP frame format updates for IEEE802.1
AS draft 5-0 2_02a mbr 09/16/09 Updates for programmable PTP timers 2_04a kag
07/23/10 PTP frame format updates for IEEE802.1 AS draft 6-7 3_01a kag 08/29/11
Added new APIs to update the RX Filter Control Reg. Fix for CR:572539. Updated
bit map for Rx Filter control reg. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb_ptp_packets.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xavb_rtc_sync.c The XAvb
driver. Functions in this file all contain calculations which are essential for
the AVB (1588 based) Real Time Clock (RTC) Sychronisation. In here are functions
to measure the Link Delay (Master and Slave); to measure and correct the current
RTC error (Slave); to measure and correct the current RTC increment rate error.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a mbr
09/19/08 First release 1.01a mbr 06/24/09 PTP frame format updates for IEEE802.1
AS draft 5-0 2_02a mbr 09/16/09 Updates for programmable PTP timers 2_04a kag
07/23/10 PTP frame format updates for IEEE802.1 AS draft 6-7 3_01a kag 08/29/11
Added new APIs to update the RX Filter Control Reg. Fix for CR:572539. Updated
bit map for Rx Filter control reg. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/examples/avb/xavb_rtc_sync.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet.c @addtogroup
axiethernet_v5_8 @{ The APIs in this file takes care of the primary
functionalities of the driver. The APIs in this driver take care of the
following: - Starting or stopping the Axi Ethernet device - Initializing and
resetting the Axi Ethernet device - Setting MAC address and speed/duplex of the
device - Provide means for controlling the PHY and communicating with it. - Turn
on/off various features/options provided by the Axi Ethernet device. See
xaxiethernet.h for a detailed description of the driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa 6/30/10 First
release based on the ll temac driver 1.02a asa 2/16/11 Made changes in
XAxiEthernet_Reset to insert delays. 3.02a srt 4/13/13 Removed Warnings (CR
704998). 5.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425.
Changed the prototype of XAxiEthernet_CfgInitialize API. 5.7 srm 01/16/18
Implemented poll timeout API which replaces while loops to ensure a
deterministic time delay. 5.8 rsp 07/20/18 Fix cppcheck warning in Aptr
assignment. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/src/xaxiethernet.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet.h @addtogroup
axiethernet_v5_8 @{ @details The Xilinx AXI Ethernet MAC driver component. This
driver supports hard Ethernet core for Virtex-6(TM) devices and soft Ethernet
core for Spartan-6(TM) and other supported devices. The supported speed can be
10/100/1000 Mbps and can reach up to 2000/2500 Mbps (1000Base-X versions). For a
full description of AXI Ethernet features, please see the hardware spec. This
driver supports the following features: - Memory mapped access to host interface
registers - Virtual memory support - Unicast, broadcast, and multicast receive
address filtering - Full duplex operation - Automatic source address insertion
or overwrite (programmable) - Automatic PAD & FCS insertion and stripping
(programmable) - Flow control - VLAN frame support - Pause frame support - Jumbo
frame support - Partial and full checksum offload - Extended multicast addresses
to 223. - Extended VLAN translation, tagging and stripping supports. <h2>Driver
Description</h2> The device driver enables higher layer software (e.g., an
application) to configure a Axi Ethernet device. It is intended that this driver
be used in cooperation with another driver (FIFO or DMA) for data communication.
This device driver can support multiple devices even when those devices have
significantly different configurations. <h2>Initialization & Configuration</h2>
The XAxiEthernet_Config structure can be used by the driver to configure itself.
This configuration structure is typically created by the tool-chain based on
hardware build properties, although, other methods are allowed and currently
used in some systems. To support multiple runtime loading and initialization
strategies employed by various operating systems, the driver instance can be
initialized using the XAxiEthernet_CfgInitialze() routine. <h2>Interrupts and
Asynchronous Callbacks</h2> The driver has no dependencies on the interrupt
controller. It provides no interrupt handlers. The application/OS software
should set up its own interrupt handlers if required. <h2>Device Reset</h2> When
a Axi Ethernet device is connected up to a FIFO or DMA core in hardware, errors
may be reported on one of those cores (FIFO or DMA) such that it can be
determined that the Axi Ethernet device needs to be reset. If a reset is
performed, the calling code should also reconfigure and reapply the proper
settings in the Axi Ethernet device. When a Axi Ethernet device reset is
required, XAxiEthernet_Reset() should be utilized. <h2>Virtual Memory</h2> This
driver may be used in systems with virtual memory support by passing the
appropriate value for the <i>EffectiveAddress</i> parameter to the
XAxiEthernet_CfgInitialize() routine. <h2>Transferring Data</h2> The Axi
Ethernet core by itself is not capable of transmitting or receiving data in any
meaningful way. Instead the Axi Ethernet device need to be connected to a FIFO
or DMA core in hardware. This Axi Ethernet driver is modeled in a similar
fashion where the application code or O/S adapter driver needs to make use of a
separate FIFO or DMA driver in connection with this driver to establish
meaningful communication over Ethernet. <h2>Checksum Offloading</h2> If
configured, the device can compute a 16-bit checksum from frame data. In most
circumstances this can lead to a substantial gain in throughput. The checksum
offload settings for each frame sent or received are transmitted through the
AXI4-Stream interface in hardware. What this means is that the checksum offload
feature is indirectly controlled in the Axi Ethernet device through the driver
for DMA core connected to the Axi Ethernet device. Refer to the documentation
for DMA driver used for data communication on how to set the values for the
relevant AXI4-Stream control words. Since this hardware implementation is
general purpose in nature system software must perform pre and post frame
processing to obtain the desired results for the types of packets being
transferred. Most of the time this will be TCP/IP traffic. TCP/IP and UDP/IP
frames contain separate checksums for the IP header and UDP/TCP header+data. For
partial checksum offloading (enabled while configuring the hardware), the IP
header checksum cannot be offloaded. Many stacks that support offloading will
compute the IP header if required and use hardware to compute the UDP/TCP
header+data checksum. There are other complications concerning the IP pseudo
header that must be taken into consideration. Readers should consult a TCP/IP
design reference for more details. For full checksum offloading (enabled while
configuring the hardware), the IPv4 checksum calculation and validation can also
be offloaded at the harwdare. Full checksum offload is supported only under
certain conditions. IP checksum offload will be supported on valid IP datagrams
that meet the following conditions. - If present, the VLAN header is 4 bytes
long - Encapsulation into the Ethernet frame is either Ethernet II or Ethernet
SNAP format - Only IPv4 is supported. IPv6 is not supported. - IP header is a
valid length TCP/UDP checksum offloading will be supported on valid TCP/UDP
segments that meet the following conditions. - Encapsulated in IPv4 (IPv6 is not
supported) - Good IP header checksum - No fragmentation - TCP or UDP segment
When full checksum offload is enabled, the hardware does the following: -
Calculates the IP header checksum and inserts it in the IP header. - Calculates
the TCP/UDP Pseudo header from IP header. - Calculates TCP/UDP header from,
TCP/UDP psedu header, TCP/UDP header and TCP/UDP payload. - On the receive path,
it again calculates all the above and validates for IP header checksum and
TCP/UDP checksum. There are certain device options that will affect the checksum
calculation performed by hardware for Tx: - FCS insertion disabled
(XAE_FCS_INSERT_OPTION): software is required to calculate and insert the FCS
value at the end of the frame, but the checksum must be known ahead of time
prior to calculating the FCS. Therefore checksum offloading cannot be used in
this situation. And for Rx: - FCS/PAD stripping disabled (XAE_FCS_STRIP_OPTION):
The 4 byte FCS at the end of frame will be included in the hardware calculated
checksum. software must subtract out this data. - FCS/PAD stripping disabled
(XAE_FCS_STRIP_OPTION): For frames smaller than 64 bytes, padding will be
included in the hardware calculated checksum. software must subtract out this
data. It may be better to allow the TCP/IP stack verify checksums for this type
of packet. - VLAN enabled (XAE_VLAN_OPTION): The 4 extra bytes in the Ethernet
header affect the hardware calculated checksum. software must subtract out the
1st two 16-bit words starting at the 15th byte. <h3>Transmit Checksum
Offloading</h3> For partial checksum offloading, for the TX path, the software
can specify where in the frame the checksum calculation is to start, where the
result should be inserted, and a seed value. The checksum is calculated from the
start point through the end of frame. For full checksum offloading, for the TX
path, the software just need to enable Full Checksum offload in the appropriate
AXI4-Stream Control word on a per packet basis. The checksum offloading settings
are sent in the transmit AXI4 Stream control words. The relevant control word
fields are described in brief below. Refer to the Axi Ethernet hardware
specification for more details. <h4>AXI4-Stream Control Word 0:</h4> <pre> Bits
1-0 : Transmit Checksum Enable: 01 - Partial checsum offload, 10 - Full checksum
offload 00 - No checksum offloading 11 - Not used, reserved Bits 27-2 : Reserved
Bits 31-28 : Used for AXI4-Stream Control Mode flag </pre> <h4>AXI4-Stream
Control Word 1:</h4> <pre> Bits 31-16 (MSB): Transmit Checksum Calculation
Starting Point: Offset in the frame where checksum calculation should begin.
Relevant only for partial checksum offloading. Bits 15-0 (LSB): Transmit
Checksum Insertion Point: Frame offset where the computed checksum value is
stored, which should be in the TCP or UDP header. Relevant only for partial
checksum offloading. </pre> <h4>AXI4-Stream Control Word 2:</h4> <pre> Bits
31-16 (MSB): Reserved Bits 0-15 (LSB): Transmit Checksum Calculation Initial
Value: Checksum seed value. Relevant only for partial checksum offloading.
</pre> <h3>Receive Checksum Offloading</h3> For partial checksum offload on the
RX path, the 15th byte to end of frame is check summed. This range of bytes is
the entire Ethernet payload (for non-VLAN frames). For full checksum offload on
the RX path, both the IP and TCP checksums are validated if the packet meets the
specified conditions. The checksum offloading information is sent in the receive
AXI4-Stream status words. There are 4 relevant status words available. However
only the relevant status words are described in brief below. Refer to the Axi
Ethernet hardware specification for more details. <h4>AXI4-Stream Status Word
0:</h4> <pre> Bits 31-28 (MSB): Always 0x5 to represent receive status frame
Bits 27-16 : Undefined Bits 15-0 (LSB): MCAST_ADR_U. Upper 16 bits of the
multicast destination address of the frame. <h4>AXI4-Stream Status Word 1:</h4>
</pre> Bits 31-0 : MCAST_ADR_L. The lower 32 bits of the multicast destination
address. <h4>AXI4-Stream Status Word 2:</h4> </pre> Bits 5-3 : Specifies the
receive full checksum status. This is relevant only for full checksum
offloading. 000 -> Neither the IP header nor the TCP/UDP checksums were checked.
001 -> The IP header checksum was checked and was correct. The TCP/UDP checksum
was not checked. 010 -> Both the IP header checksum and the TCP checksum were
checked and were correct. 011 -> Both the IP header checksum and the UDP
checksum were checked and were correct. 100 -> Reserved. 101 -> The IP header
checksum was checked and was incorrect. The TCP/UDP checksum was not checked.
110 -> The IP header checksum was checked and is correct but the TCP checksum
was checked and was incorrect. 111 -> The IP header checksum was checked and is
correct but the UDP checksum was checked and was incorrect. <h4>AXI4-Stream
Status Word 3:</h4> Bits 31-16 : T_L_TPID. This is the value of 13th and 14th
byte of the frame. Bits 15-0 : Receive Raw Checksum: Computed checksum value
<h4>AXI4-Stream Status Word 3:</h4> Bits 31-16 : VLAN_TAG. Value of 15th and
16th byte of the frame. Bits 15-0 : RX_BYTECNT. Received frame length.
<h2>Extended multicast</h2> (XAE_EXT_MULTICAST_OPTION): Allow and perform
address filtering more than 4 multicast addresses. Hardware requires to enable
promiscuous mode (XAE_PROMISCUOUS_OPTION) and disable legacy multicast mode
(XAE_MULTICAST_OPTION) for this feature to work. <h2>Extended VLAN</h2>
<h3>TX/RX VLAN stripping</h3> (XAE_EXT_[T|R]XVLAN_STRP_OPTION) handles
transmit/receive one VLAN tag stripping in Ethernet frames. To enable this
option, hardware requires to build with this feature and enable
(XAE_FCS_INSERT_OPTION), (XAE_FCS_STRP_OPTION) and disable (XAE_VLAN_OPTION).
Supports three modes, -XAE_VSTRP_NONE : no stripping -XAE_VSTRP_ALL : strip one
tag from all frames -XAE_VSTRP_SELECT : strip one tag from selected frames
<h3>TX/RX VLAN translation</h3> (XATE_EXT_[T|R]XVLAN_TRAN_OPTION) handles
transmit/receive one VLAN tag translation in Ethernet frames. To enable this
option, hardware requires to build with this feature and enable
(XATE_FCS_INSERT_OPTION), (XAE_FCS_STRP_OPTION), and disable (XAE_VLAN_OPTION).
<h3>TX/RX VLAN tagging</h3> (XAE_EXT_[T|R]XVLAN_TAG_OPTION) adds
transmit/receive one VLAN tag in Ethernet frames. To enable this option,
hardware requires to build with this feature and enable (XAE_FCS_INSERT_OPTION),
(XAE_FCS_STRP_OPTION), (XAE_JUMBO_OPTION) and disable (XAE_VLAN_OPTION). Support
four modes, -XAE_VTAG_NONE : no tagging -XAE_VTAG_ALL : tag all frames
-XAE_VTAG_EXISTED : tag already tagged frames -XAE_VTAG_SELECT : tag selected
already tagged frames <h2>PHY Communication</h2> Prior to PHY access, the MDIO
clock must be setup. This driver will set a safe default that should work with
AXI4-Lite bus speeds of up to 150 MHz and keep the MDIO clock below 2.5 MHz. If
the user wishes faster access to the PHY then the clock divisor can be set to a
different value (see XAxiEthernet_PhySetMdioDivisor()). MII register access is
performed through the functions XAxiEthernet_PhyRead() and
XAxiEthernet_PhyWrite(). <h2>Link Sync</h2> When the device is used in a multi
speed environment, the link speed must be explicitly set using
XAxiEthernet_SetOperatingSpeed() and must match the speed PHY has negotiated. If
the speeds are mismatched, then the MAC will not pass traffic. The
application/OS software may use the AutoNegotiation interrupt to be notified
when the PHY has completed auto-negotiation. <h2>Asserts</h2> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. For deployment use -DNDEBUG compiler switch
to remove assert code. <h2>Driver Errata</h2> - A dropped receive frame
indication may be reported by the driver after calling XAxiEthernet_Stop()
followed by XAxiEthernet_Start(). This can occur if a frame is arriving when
stop is called. - On Rx with checksum offloading enabled and FCS/PAD stripping
disabled, FCS and PAD data will be included in the checksum result. - On Tx with
checksum offloading enabled and auto FCS insertion disabled, the user calculated
FCS will be included in the checksum result. @note Xilinx drivers are typically
composed of two components, one is the driver and the other is the adapter. The
driver is independent of OS and processor and is intended to be highly portable.
The adapter is OS-specific and facilitates communication between the driver and
an OS. <br><br> This driver is intended to be RTOS and processor independent.
Any needs for dynamic memory management, threads or thread mutual exclusion, or
cache control must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa 6/30/10
First release based on the ll temac driver 1.01a asa 12/10/10 Added macros
XAxiEthernet_IsRxFullCsum and XAxiEthernet_IsTxFullCsum for supporting full
checksum offload. The full checksum offload is only supported in newer versions
of the core, please refer to the core HW datasheet. 1.02a asa 2/16/11 Inserted a
delay in the driver function XAxiEthernet_Reset in file xaxiethernet.c. This is
done because immediately after a core reset none of the AxiEthernet registers
are accessible for some duration. Changed the value of
XAE_LOOPS_TO_COME_OUT_OF_RST to 10000 in file xaxiethernet_hw.h. 2.00a asa
8/29/11 A new major version of AxiEthernet driver is being released to
accommodate the change in avb software. The AxiEthernet hardware v3_00_a has the
latest avb hardware which needs a corresponding change in avb software (released
in examples/avb folder). This change in avb software is not backwards compatible
(which means this avb software will not work with older axiethernet hardware).
Hence a new major version of axiethernet is being released. Added defines for
Ability Reg, Identification Reg, Rx max Frame and Tx Max Frame registers.
Changed define for TEMAC RGMII/SGMII Config (PHYC) Reg. 3.00a asa 4/10/12 A new
major version of AxiEthernet is being released to accommodate the change in AVB
example. From AxiEthernet core version 3.01a onwards the AVB implementation has
changed. The AVB module is now a part of AxiEthernet IP. Because of this change,
the AVB example works only when promiscuous mode is not enabled (unlike earlier
implementation where promiscuous mode was required for AVB example to work).
Hence the file xavb_example.c is changed so that the core is not put in
promiscuous mode. Also since AVB is a part of AxiEthernet some of the register
mappings in xavb_hw.h has changed. These changes are not backward compatible
which means this changed example will not work for previous versions of cores.
Hence a new major version of axiethernet is being released. 3.01a srt 02/03/13 -
Added support for SGMII mode (CR 676793) - Added support for IPI designs (CR
698249) 02/14/13 - Added support for Zynq (CR 681136) 3.02a srt 04/13/13 -
Removed Warnings (CR 704998). 04/24/13 - Modified parameter _SGMII_PHYADDR to
_PHYADDR, the config parameter C_PHYADDR applies to SGMII/1000BaseX modes of
operation 04/24/13 - Added support for 1000BaseX mode in examples (_util.c) (CR
704195) 04/24/13 - Added support for RGMII mode in examples (_util.c) 3.02a srt
08/06/13 - Fixed CR 727634: Modified FifoHandler() function logic of FIFO
interrupt example to reflect the bit changes in the Interrupt Status Register as
per the latest AXI FIFO stream IP. - Fixed CR 721141: Added support to handle
multiple instances of AxiEthernet FIFO interface (CR 721141) - Fixed CR 717949:
Configures external Marvel 88E1111 PHY based on the AXI Ethernet physical
interface type and allows to operate in specific interface mode without changing
jumpers on the Microblaze boards. This change is in example_util.c 3.02a adk
15/11/13 - Fixed CR 761035 removed dependency with fifo in MDD file 4.0 adk
19/12/13 - Updated as per the New Tcl API's asa 30/01/14 - Added defines for
1588 registers and bit masks Added config parameter for SGMII over LVDS 4.1 adk
21/04/14 - Fixed CR:780537 Changes are Made in the file axiethernet test-app tcl
4.2 adk 08/08/14 - Fixed CR:810643 SDK generated 'xparamters.h' erroneously
generated with errors due to part of 'define' misplaced changes are made in the
driver tcl file. 4.3 adk 29/10/14 - Added support for generating parameters for
SGMII/1000BaseX modes When IP is configured with the PCS/PMA core. Changes are
made in the driver tcl file (CR 828796). 4.4 adk 8/1/15 - Fixed TCL errors when
axiethernet is configured with the Axi stream fifo (CR 835605). Changes are made
in the driver tcl file. 5.0 adk 13/06/15 - Updated the driver tcl for Hier IP(To
support User parameters). 5.0 adk 28/07/15 - Fixed CR:870631 AXI Ethernet with
FIFO will fail to Create the BSP if the interrupt pin on the FIFO is unconnected
5.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed
the prototype of XAxiEthernet_CfgInitialize API. 5.1 adk 30/01/15 Fix
compilation errors in case of zynqmp. CR933825. 5.1 adk 02/11/16 Updated example
to Support ZynqMp. 5.2 adk 13/05/16 Fixed CR951669 Fix compilation errors when
axi dma interrupts are not connected. 5.3 adk 05/10/16 Fixed CR961152 PMU
template firmware fails to compile on ZynqMP AXI-Ethernet designs. 5.4 adk
07/12/16 Added Support for TI PHY DP83867 changes are made in the examples
xaxiethernet_example_util.c file. ms 01/23/17 Modified xil_printf statement in
main function for all examples to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. adk 03/09/17
Fixed CR971367 fix race condition in the tcl for a multi mac
design(AXI_CONNECTED_TYPE defined for only one instance) ms 03/17/17 Modified
text file in examples folder for doxygen generation. ms 04/05/17 Added tabspace
for return statements in functions of axiethernet examples for proper
documentation while generating doxygen. 5.5 adk 19/05/17 Increase Timeout value
in the driver as per new h/w update i.e. Increase of transceiver initialization
times in ultrascale+ devices (CR976244). 5.6 adk 03/07/17 Fixed issue lwip stops
working as soon as something is plugged to it`s AXI stream bus (CR979634).
Changes are made in the driver tcl and test app tcl. 5.6 adk 03/07/17 Fixed
CR979023 Intr fifo example failed to compile. ms 04/18/17 Modified tcl file to
add suffix U for all macro definitions of axiethernet in xparameters.h adk
08/08/17 Fixed CR981893 Fix bsp compilation error for axiethernet mcdma chiscope
based designs. ms 08/16/17 Fixed compilation warnings in xaxiethernet_sinit.c
adk 08/22/17 Fixed CR983008 app generation errors for Specific IPI design. adk
08/28/17 Fixed CR982877 couple of dsv_ced tests are failing in peripheral app
generation. adk 09/21/17 Fixed CR985686 bsp generation error with specific
design. Changes are made in the driver tcl. 5.7 rsp 01/09/18 Add NumTableEntries
member in XAxiEthernet_Config. Instead of define XAE_MULTI_MAT_ENTRIES derive
multicast table entries max count from ethernet config structure. 01/11/18 Fixed
CR976392 Use UINTPTR for DMA base address. </pre>

FILES:
XilinxProcessorIPLib/drivers/axiethernet/src/xaxiethernet.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_control.c
@addtogroup axiethernet_v5_8 @{ This file has driver APIs related to the
controlling of the extended features of the AXI Ethernet device. Please note
that APIs for turning on/off any of the driver features are present in
axiethernet.c. This file takes care of controlling these features. -
Normal/extended multicast filtering - Normal/extended VLAN features -
RGMII/SGMII features See xaxiethernet.h for a detailed description of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a asa 6/30/10 First release based on the ll temac driver 5.7 rsp 01/09/18
Instead of define XAE_MULTI_MAT_ENTRIES derive multicast table entries max count
from ethernet config structure. 5.8 rsp 07/20/18 Fix cppcheck warning in Aptr
assignment. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/src/xaxiethernet_control.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_hw.h @addtogroup
axiethernet_v5_8 @{ This header file contains identifiers and macros that can be
used to access the Axi Ethernet device. The driver APIs/functions are defined in
xaxiethernet.h. @note <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a asa 6/30/10 First release for Axi Ethernet driver 1.02a asa
2/16/11 Changes the value of XAE_LOOPS_TO_COME_OUT_OF_RST to 10000. 2.00a asa
8/29/11 Added defines for Ability Reg, Identification Reg, Rx max Frame and Tx
Max Frame registers. Changed define for TEMAC RGMII/SGMII Config (PHYC) Reg.
5.70 srm 01/16/18 Added a new macro to support poll timeout implementation
</pre>

FILES:
XilinxProcessorIPLib/drivers/axiethernet/src/xaxiethernet_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_porting_guide.h
@addtogroup axiethernet_v5_8 @{ This is a guide on how to move from using the ll
temac driver to use the xaxiethernet driver. The AXI Ethernet IP is based on the
XPS_LL TEMAC IP. There are few changes in the IP and some of them are listed
below - The Interface to access the IP is now AXI instead of the PLBV46 - AXI4
streaming interfaces is used instead of LL (Local Link) - All indirect accesses
to Ethernet core registers have been removed. - The AxiEthernet reset line is
connected to the reset line of the device connected to the AXI4-Stream
interface. Hence any reset of the connected device would reset AxiEthernet.
Please read the HW Device specification of the AXI Ethernet IP for further
information. The AXI Ethernet can be used in a DMA mode using the AXI DMA or
used in a FIFO mode using the AXI Streaming FIFO. There is a new driver for AXI
DMA which is used by the AXi Ethernet. Please refer the xaxidma_porting_guide.h
provided as a part of the AXI DMA driver to see the differences from the LL DMA
driver. The LL FIFO driver is a common driver for the LL FIFO and the AXI
Streaming FIFO. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ASA 07/18/10 First release </pre> <b>Overview</b> The API for
xaxiethernet driver are similar to xlltemac driver. The prefix for the API
functions and structures is XAxiEthernet_ for the xaxiethernet driver. The
prefix for all hash-defines (option masks or generic hash-defined constants)
start with XAE_. The Axi Ethernet API "XAxiEthernet_Reset" is different from the
corresponding LLTEMAC API "XLlTemac_Reset". The AxiEthernet version does not do
a soft reset of the AxiEthernet hardware. Since AxiEthernet hardware could only
be reset through the device connected to the AxiEthernet AXI4-Stream interface,
the user must ensure that AxiEthernet hardware initialization happens after the
initialization of the other device. These are the classification of the APIs -
APIs that only have prefix changes - APIs that have been renamed - APIs that are
new Note that data structures have different prefix of XAxiEthernet_. Those API
functions, that have data structures with prefix change, are considered as
prefix change. <b>API Functions That Only Have Prefix Changes</b> Most of the
functions have the prefix change and are given below <pre> xlltemac driver |
xaxiethernet driver XLlTemac_IsStarted(...) | XAxiEthernet_IsStarted(...)
XLlTemac_IsDma(...) | XAxiEthernet_IsDma(...) XLlTemac_IsFifo(...) |
XAxiEthernet_IsFifo(...) XLlTemac_LlDevBaseAddress(...) |
XAxiEthernet_AxiDevBaseAddress(...) XLlTemac_IsRecvFrameDropped(...) |
XAxiEthernet_IsRecvFrameDropped(...) XLlTemac_GetPhysicalInterface(...) |
XAxiEthernet_GetPhysicalInterface(...) XLlTemac_IntEnable(...) |
XAxiEthernet_IntEnable(...) XLlTemac_IntDisable(...) |
XAxiEthernet_IntDisable(...) XLlTemac_IntPending(...) |
XAxiEthernet_IntPending(...) XLlTemac_IntClear(...) | XAxiEthernet_IntClear(...)
XLlTemac_IsExtFuncCap(...) | XAxiEthernet_IsExtFuncCap(...)
XLlTemac_IsExtMcastEnable(...) | XAxiEthernet_IsExtMcastEnable(...)
XLlTemac_IsExtMcast(...) | XAxiEthernet_IsExtMcast(...)
XLlTemac_IsTxVlanStrp(...) | XAxiEthernet_IsTxVlanStrp(...)
XLlTemac_IsRxVlanStrp(...) | XAxiEthernet_IsRxVlanStrp(...)
XLlTemac_IsTxVlanTran(...) | XAxiEthernet_IsTxVlanTran(...)
XLlTemac_IsRxVlanTran(...) | XAxiEthernet_IsRxVlanTran(...)
XLlTemac_IsTxVlanTag(...) | XAxiEthernet_IsTxVlanTag(...)
XLlTemac_IsRxVlanTag(...) | XAxiEthernet_IsRxVlanTag(...) XLlTemac_SetOptions
(...) | XAxiEthernet_SetOptions(...) XLlTemac_ClearOptions(...) |
XAxiEthernet_ClearOptions(...) XLlTemac_GetOptions(...) |
XAxiEthernet_GetOptions(...) XLlTemac_SetMacAddress(...) |
XAxiEthernet_SetMacAddress(...) XLlTemac_GetMacAddress(...) |
XAxiEthernet_GetMacAddress(...) XLlTemac_SetMacPauseAddress(...) |
XAxiEthernet_SetMacPauseAddress(...) XLlTemac_GetMacPauseAddress(...) |
XAxiEthernet_GetMacPauseAddress(...) XLlTemac_SendPausePacket(...) |
XAxiEthernet_SendPausePacket(...) XLlTemac_GetSgmiiStatus(...) |
XAxiEthernet_GetSgmiiStatus(...) XLlTemac_GetRgmiiStatus(...) |
XAxiEthernet_GetRgmiiStatus(...) ... XLlTemac_GetOperatingSpeed(...) |
XAxiEthernet_GetOperatingSpeed(...) XLlTemac_SetOperatingSpeed(...) |
XAxiEthernet_SetOperatingSpeed(...) XLlTemac_PhySetMdioDivisor(...) |
XAxiEthernet_PhySetMdioDivisor(...) XLlTemac_PhyRead(...) |
XAxiEthernet_PhyRead(...) XLlTemac_PhyWrite(...) | XAxiEthernet_PhyWrite(...)
XLlTemac_MulticastAdd(...) | XAxiEthernet_MulticastAdd(...)
XLlTemac_MulticastGet(...) | XAxiEthernet_MulticastGet(...)
XLlTemac_MulticastClear(...) | XAxiEthernet_MulticastClear(...)
XLlTemac_SetTpid(...) | XAxiEthernet_SetTpid(...) XLlTemac_ClearTpid(...) |
XAxiEthernet_ClearTpid(...) XLlTemac_GetTpid(...) | XAxiEthernet_GetTpid(...)
XLlTemac_SetVTagMode(...) | XAxiEthernet_SetVTagMode(...)
XLlTemac_GetVTagMode(...) | XAxiEthernet_GetVTagMode(...)
XLlTemac_SetVStripMode(...) | XAxiEthernet_SetVStripMode(...)
XLlTemac_GetVStripMode(...) | XAxiEthernet_GetVStripMode(...)
XLlTemac_SetVTagValue(...) | XAxiEthernet_SetVTagValue(...)
XLlTemac_GetVTagValue(...) | XAxiEthernet_GetVTagValue(...)
XLlTemac_SetVidTable(...) | XAxiEthernet_SetVidTable(...)
XLlTemac_GetVidTable(...) | XAxiEthernet_GetVidTable(...)
XLlTemac_AddExtMulticastGroup(...) | XAxiEthernet_AddExtMulticastGroup(...)
XLlTemac_ClearExtMulticastGroup(..)| XAxiEthernet_ClearExtMulticastGroup(...)
XLlTemac_GetExtMulticastGroup(...) | XAxiEthernet_GetExtMulticastGroup(...)
XLlTemac_DumpExtMulticastGroup(..) | XAxiEthernet_DumpExtMulticastGroup(...)
</pre> <b>API Function names that have changed </b> <pre> xlltemac driver |
xaaxiethernet driver XLlTemac_IsRxCsum(...) | XAxiEthernet_IsRxPartialCsum(...)
XLlTemac_IsTxCsum(...) | XAxiEthernet_IsTxPartialCsum(...) XLlTemac_Status(...)
| XAxiEthernet_GetIntStatus </pre> <b>API Functions That Are New API
Functions</b> - XAxiEthernet_GetTemacType(...) -
XAxiEthernet_IsAvbConfigured(...) - XAxiEthernet_IsStatsConfigured(...) -
XAxiEthernet_SetBadFrmRcvOption((...); - XAxiEthernet_ClearBadFrmRcvOption(...);
- XAxiEthernet_DisableControlFrameLenCheck(...) -
XAxiEthernet_EnableControlFrameLenCheck(...) @} /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/src/xaxiethernet_porting_guide.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxiethernet_sinit.c
@addtogroup axiethernet_v5_8 @{ This file contains static initialization
functionality for Axi Ethernet driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a asa 6/30/10 First release 5.6 ms 08/07/17
Fixed compilation warning. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axiethernet/src/xaxiethernet_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: 03/22/11 rkv
First Release

FILES:
XilinxProcessorIPLib/drivers/axipcie/data/axipcie.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 03/22/10 rkv First Release 09/06/13 srt Fixed
CR 734175: C_BASEADDR and C_HIGHADDR configuration parameters are renamed to
BASEADDR and HIGHADDR in Vivado builds. Modified the tcl for this change. 3.0
adk 10/12/13 Updated as per the New Tcl API's uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/axipcie/data/axipcie.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_ep_cdma_example.c This
file contains a design example for using AXI PCIe IP and its driver. The example
handles AXI PCIe IP when it is configured as an end point. It shows how to
transfer data between system memory and end point memory. The user has to enter
both addresses for source and destination. One of the addresses should be in
system memory and the other one in the memory local to an end point(mapped to
memory space of the system). This example assumes that there is an AXI CDMA IP
in the system. The user has to specify the Source, Destination and the Length of
the DMA transfer which are valid for this system and are defined
AXICDMA_SRC_ADDR, AXICDMA_DEST_ADDR and AXICDMA_LENGTH respectively in this
example. @note This code will illustrate how the AXI Pcie IP and its standalone
driver can be used to: - Initialize a PCIe bridge core built as an end point -
Retrieve root complex configuration assigned to end point - Move data form
system memory to end point memory using AXICDMA IP. We tried to use as much of
the driver's API calls as possible to show the reader how each call could be
used and that probably made the example not the shortest way of doing the tasks
shown as they could be done. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a rkv 03/07/11 Initial version based on PLB PCIE example
2.00a nm 10/19/11 Renamed function call XAxiPcie_GetRequestId to
XAxiPcie_GetRequesterId 3.1 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 04/05/17 Added tabspace for return
statements in functions for proper documentation while generating doxygen.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/examples/xaxipcie_ep_cdma_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_ep_enable_example.c
This file contains a design example for using AXI PCIe IP and its driver. The
example handles AXI PCIe IP when it is configured as an end point. It shows how
to use the API's. @note This code will illustrate how the AXI Pcie IP and its
standalone driver can be used to: - Initialize a AXI PCIe bridge core built as
an end point - Retrieve root complex configuration assigned to end point We
tried to use as much of the driver's API calls as possible to show the reader
how each call could be used and that probably made the example not the shortest
way of doing the tasks shown as they could be done. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a rkv 03/07/11 Initial version
based on PLB PCIE example 2.00a rkv 10/19/11 Renamed function call
XAxiPcie_GetRequestId to XAxiPcie_GetRequesterId 3.1 ms 01/23/17 Added
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/examples/xaxipcie_ep_enable_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_rc_cdma_example.c This
file contains a design example for using AXI PCIe IP and its driver. This is an
example to show the usage of driver APIs when AXI PCIe IP is configured as a
Root Port. The AXI PCIe can be configured as a Root Port only on the 7 Series
Xilinx FPGA families. The example initialises the AXI PCIe IP, shows how to
enumerate the PCIe system and transfer data between endpoint and root complex
using Central DMA. This example assumes that there is an AXI CDMA IP in the
system. The user has to specify the Source, Destination and the Length of the
DMA transfer which are valid for this system and are defined AXICDMA_SRC_ADDR,
AXICDMA_DEST_ADDR and AXICDMA_LENGTH respectively in this example. @note This
example should be used only when AXI PCIe IP is configured as root complex and
AXI CDMA IP in included in system. This code will illustrate how the XAxiPcie IP
and its standalone driver can be used to: - Initialize a AXI PCIe IP core built
as a root complex. - Enumerate PCIe end points in the system. - Transfer data
between root complex and endpoint using CDMA. Please note that this example
enumerates and initializes PCIe end points only. It does not shows how to deal
with PCIe switches (and its virtual P2P bridges) We tried to use as much of the
driver's API calls as possible to show the reader how each call could be used
and that probably made the example not the shortest way of doing the tasks shown
as they could be done. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 2.00a nm 10/19/11 Initial version of AXI PCIe Root Port example
3.1 ms 01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 04/05/17 Added tabspace for return statements in functions
for proper documentation while generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/examples/xaxipcie_rc_cdma_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_rc_enumerate_example.c
This file contains a design example for using AXI PCIe IP and its driver. This
is an example to show the usage of driver APIs when AXI PCIe IP is configured as
a Root Port. The AXI PCIe can be configured as a Root Port only on the 7 Series
Xilinx FPGA families. The example initialises the AXI PCIe IP and shows how to
enumerate the PCIe system. @note This example should be used only when AXI PCIe
IP is configured as root complex. This code will illustrate how the XAxiPcie IP
and its standalone driver can be used to: - Initialize a AXI PCIe IP core built
as a root complex - Enumerate PCIe end points in the system Please note that
this example enumerates and initializes PCIe end points only. It does not shows
how to deal with PCIe switches (and its virtual P2P bridges) We tried to use as
much of the driver's API calls as possible to show the reader how each call
could be used and that probably made the example not the shortest way of doing
the tasks shown as they could be done. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 2.00a nm 10/19/11 Initial version of AXI PCIe root
complex example 2.02a nm 08/19/12 Removed the calls to
XAxiPcie_GetLocalBusBar2PcieBar and XAxiPcie_SetLocalBusBar2PcieBar as they are
not needed for enumeration 3.1 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 04/05/17 Added tabspace for return
statements in functions for proper documentation while generating doxygen.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/examples/xaxipcie_rc_enumerate_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie.c @addtogroup
axipcie_v3_1 @{ Implements all of functions for XAxiPcie IP driver except
interrupts and initialization. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a rkv 03/03/11 Original code. 2.00a nm 10/19/11 Added
support of pcie root complex functionality. Changed these functions -renamed
function XAxiPcie_GetRequestId to XAxiPcie_GetRequesterId -added two functions
arguments RootPortPtr & ECAMSizePtr to XAxiPcie_GetBridgeInfo API Added these
new API for root complex support - XAxiPcie_SetRequesterId -
XAxiPcie_GetRootPortStatusCtrl - XAxiPcie_SetRootPortStatusCtrl -
XAxiPcie_SetRootPortMSIBase - XAxiPcie_GetRootPortErrFIFOMsg -
XAxiPcie_ClearRootPortErrFIFOMsg - XAxiPcie_GetRootPortIntFIFOReg -
XAxiPcie_ClearRootPortIntFIFOReg - XAxiPcie_WriteLocalConfigSpace -
XAxiPcie_ComposeExternalConfigAddress - XAxiPcie_ReadRemoteConfigSpace -
XAxiPcie_WriteRemoteConfigSpace 2.01a nm 04/01/12 Removed
XAxiPcie_SetRequesterId and XAxiPcie_SetBlPortNumber APIs as these are writing
to Read Only bits for CR638299. 2.02a nm 08/01/12 Updated for removing
compilation errors with C++, changed XCOMPONENT_IS_READY to
XIL_COMPONENT_IS_READY Removed the Endian Swap in XAxiPcie_ReadRemoteConfigSpace
and XAxiPcie_WriteRemoteConfigSpace APIs as the HW has been fixed and the
swapping is not required in the driver (CR 657412) 2.03a srt 04/13/13 Removed
Warnings (CR 705004). 3.1 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototype of XAxiPcie_CfgInitialize API.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/src/xaxipcie.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie.h @addtogroup
axipcie_v3_1 @{ @details This file contains the software API definition of the
Xilinx AXI PCIe IP (XAxiPcie). This driver provides "C" function interface to
application/upper layer to access the hardware. <b>Features</b> The driver
provides its user with entry points - To initialize and configure itself and the
hardware - To access PCIe configuration space locally - To enable/disable and to
report errors (interrupts). <b>IP Hardware Configuration</b> The AXI PCIE IP
supports only the endpoint for Virtex-6 and Spartan-6 families. The AXI PCIE
IP supports both the endpoint and Root Port for the Kintex 7 devices. <b>Driver
Initialization & Configuration</b> The XAxiPcie_Config structure is used by the
driver to configure itself. This configuration structure is typically created by
the tool-chain based on HW build properties. To support multiple runtime loading
and initialization strategies employed by various operating systems, the driver
instance can be initialized in the following way: -
XAxiPcie_LookupConfig(DeviceId) - Use the device identifier to find the static
configuration structure defined in xaxipcie_g.c. This is setup by the tools. For
some operating systems the config structure will be initialized by the software
and this call is not needed. - XAxiPcie_CfgInitialize(InstancePtr, CfgPtr,
EffectiveAddr) - Uses a configuration structure provided by the caller. If
running in a system with address translation, the provided virtual memory base
address replaces the physical address present in the configuration structure.
<b>Interrupt Management</b> The XAxiPcie driver provides interrupt management
functions. It allows the caller to enable/disable each individual interrupt as
well as get/clear pending interrupts. Implementation of callback handlers is
left to the user. @note <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a rkv 03/03/11 Original code. 2.00a nm 10/19/11 Added support
of pcie root complex functionality. Changed these functions -renamed function
XAxiPcie_GetRequestId to XAxiPcie_GetRequesterId -added two functions arguments
RootPortPtr & ECAMSizePtr to XAxiPcie_GetBridgeInfo API Added these new API for
root complex support - XAxiPcie_GetRootPortStatusCtrl -
XAxiPcie_SetRootPortStatusCtrl - XAxiPcie_SetRootPortMSIBase -
XAxiPcie_GetRootPortErrFIFOMsg - XAxiPcie_ClearRootPortErrFIFOMsg -
XAxiPcie_GetRootPortIntFIFOReg - XAxiPcie_ClearRootPortIntFIFOReg -
XAxiPcie_WriteLocalConfigSpace - XAxiPcie_ComposeExternalConfigAddress -
XAxiPcie_ReadRemoteConfigSpace - XAxiPcie_WriteRemoteConfigSpace 2.01a nm
04/01/12 Removed XAxiPcie_SetRequesterId and XAxiPcie_SetBlPortNumber APIs as
these are writing to Read Only bits for CR638299. 2.02a nm 08/01/12 Updated for
removing compilation errors with C++, changed XCOMPONENT_IS_READY to
XIL_COMPONENT_IS_READY Removed the Endian Swap in XAxiPcie_ReadRemoteConfigSpace
and XAxiPcie_WriteRemoteConfigSpace APIs as the HW has been fixed and the
swapping is not required in the driver (CR 657412) 2.03a srt 04/13/13 Removed
Warnings (CR 705004). 2.04a srt 09/06/13 Fixed CR 734175: C_BASEADDR and
C_HIGHADDR configuration parameters are renamed to BASEADDR and HIGHADDR in
Vivado builds. Modified the tcl for this change. 3.0 adk 19/12/13 Updated as per
the New Tcl API's 3.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR
867425. Changed the prototype of XAxiPcie_CfgInitialize API. ms 01/23/17 Added
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. ms 04/05/17 Added tabspace for return statements in
functions of axipcie examples for proper documentation while generating doxygen.
</pre>

FILES:
XilinxProcessorIPLib/drivers/axipcie/src/xaxipcie.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_g.c @addtogroup
axipcie_v3_1 @{ This file contains a configuration table that specifies the
configuration of AXI PCIe devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a rkv 03/03/11 Original code. 2.00a rkv
07/19/11 Added support of pcie root complex functionality. </pre> @note None.
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/src/xaxipcie_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_hw.h @addtogroup
axipcie_v3_1 @{ This header file contains identifiers and basic driver functions
for the XAxiPcie device driver. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a rkv 03/03/11 Original code. 2.00a nm
09/19/11 Root port related changes are done. </pre>

FILES:
XilinxProcessorIPLib/drivers/axipcie/src/xaxipcie_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_intr.c @addtogroup
axipcie_v3_1 @{ This file implements interrupt functions for the XAxiPcie IP
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rkv
03/03/11 Original code. 2.02a nm 08/01/12 Updated for removing compilation
errors with C++, changed XCOMPONENT_IS_READY to XIL_COMPONENT_IS_READY </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/src/xaxipcie_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_porting_guide.h
@addtogroup axipcie_v3_1 @{ This is a guide on how to move from using the
plbv46pcie driver to use xaxipcie driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a rkv 03/21/11 First release 2.00a nm
10/19/11 Added support of PCIe root complex functionality. The Root Port/Root
Complex is available only in the 7 series families. </pre> <b>Overview</b> The
API for xaxipcie driver is similar to plbv46pcie driver. The prefix for the API
functions and structures is XAxiPcie_ for the xaxipcie driver. Due to hardware
feature changes, some new API's are added and some API names are changed. We
present AXI PCIE API functions: - That Map with PLBv46PCIE - That are new API
functions - That have been removed <b>AXI PCIE API Functions that maps with
PLBv46PCIE API</b> <pre> plbv46pcie driver | xaxipcie driver XPcie_LookupConfig(
) | XAxiPcie_LookupConfig(...) XPcie_CfgInitialize(...) |
XAxiPcie_CfgInitialize(...) XPcie_GetRequesterID(...) |
XAxiPcie_GetRequesterID(...) XPcie_SetRequesterID(...) |
............................ XPcie_GetLinkStatus(...) | XAxiPcie_IsLinkUp(...)
XPcie_GetLocalBusBar2PcieBar(...)| XAxiPcie_GetLocalBusBar2PcieBar(...)
XPcie_SetLocalBusBar2PcieBar(...)| XAxiPcie_SetLocalBusBar2PcieBar(...)
XPcie_ReadLocalConfigSpace(...) | XAxiPcie_ReadLocalConfigSpace(...)
XPcie_WriteLocalConfigSpace(...) | XAxiPcie_WriteLocalConfigSpace(...)
XPcie_EnableInterrupts(...) | XAxiPcie_EnableInterrupts(...)
XPcie_DisableInterrupts(...) | XAxiPcie_DisableInterrupts(...)
XPcie_GetEnabledInterrupts(...) | XAxiPcie_GetEnabledInterrupts(...)
XPcie_GetPendingInterrupts(...) | XAxiPcie_GetPendingInterrupts(...)
XPcie_ClearPendingInterrupts(...)| XAxiPcie_ClearPendingInterrupts(...)
XPcie_SetRequesterID(...) | XAxiPcie_SetRequesterID(...)
XPcie_EnablePCIeConnection(...) | No enable feature in hardware.
XPcie_DisablePCIeConnection(..) | No Disable feature in hardware.
XPcie_ReadRemoteConfigSpace(..) | XAxiPcie_ReadRemoteConfigSpace(..)
XPcie_WriteRemoteConfigSpace(..) | XAxiPcie_WriteRemoteConfigSpace(..) </pre>
<b>API Functions that are new</b> - void XAxiPcie_GetVsecCapability(XAxiPcie
InstancePtr, u8 VsecNum, u16 VsecIdPtr, u8 VersionPtr, u16 NextCapPtr) - void
XAxiPcie_GetVsecHeader(XAxiPcie InstancePtr, u8 VsecNum, u16 VsecIdPtr, u8
RevisionPtr, u16 LengthPtr) - void XAxiPcie_GetBridgeInfo(XAxiPcie InstancePtr,
u8 Gen2Ptr, u8 RootPortPtr, u8 ECAMSizePtr); - void
XAxiPcie_GetPhyStatusCtrl(XAxiPcie InstancePtr, u32 PhyState) - void
XAxiPcie_EnableGlobalInterrupt(XAxiPcie InstancePtr) - void
XAxiPcie_DisableGlobalInterrupt(XAxiPcie InstancePtr) - void
XAxiPcie_GetRootPortStatusCtrl(XAxiPcie InstancePtr, u32 StatusPtr) - int
XAxiPcie_SetRootPortMSIBase(XAxiPcie InstancePtr, unsigned long long MsiBase) -
void XAxiPcie_GetRootPortErrFIFOMsg(XAxiPcie InstancePtr, u16 ReqIdPtr, u8
ErrType, u8 ErrValid) - void XAxiPcie_ClearRootPortErrFIFOMsg(XAxiPcie
InstancePtr) - int XAxiPcie_GetRootPortIntFIFOReg(XAxiPcie InstancePtr, u16
ReqIdPtr, u16 MsiAddr, u8 MsiInt, u8 IntValid, u16 MsiMsgData) - void
XAxiPcie_ClearRootPortIntFIFOReg(XAxiPcie InstancePtr) <b>API Functions That
Have Been Removed</b> - void XPcie_GetRequestControl(XPcie InstancePtr, u8
MaxPayLoadPtr, u8 MaxReadPtr) - void XPcie_EnablePCIeConnection(XPcie
InstancePtr, u8 NumOfBars) - void XPcie_DisablePCIeConnection(XPcie InstancePtr)
@} /

FILES:
XilinxProcessorIPLib/drivers/axipcie/src/xaxipcie_porting_guide.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipcie_sinit.c @addtogroup
axipcie_v3_1 @{ This file contains the implementation of AXI PCIe driver's
static initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a rkv 03/03/11 Original code. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/axipcie/src/xaxipcie_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 6.1 adk 16/04/14 Added two new
parameters(C_S_AXI4_BASEADDR, C_S_AXI4_HIGHADDR) 6.2 bss 02/03/15 Added support
to handle - Zynq MP APM Baseaddress(C_S_AXI_BASEADDR) - SoftIP APM
Baseaddress(C_BASEADDR) 6.6 ms 04/18/17 Modified tcl file to add suffix U for
all macros definitions of axipmon in xparameters.h uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/axipmon/data/axipmon.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon_intr_example.c This
file contains a design example showing how to use the driver APIs of the AXI
Performance Monitor driver in interrupt mode. @note Metric Counters are enabled.
The Application/design for which Metrics need to be computed should be run and
then the Metrics collected. Sampled Metric Counter is read after Sample Metric
Counter Interrupt occurs. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
----- -------- 1.00a bss 02/29/12 First release 2.00a bss 06/23/12 Updated to
support v2_00a version of IP. 3.00a bss 09/03/12 Deleted XAxiPmon_SetAgent API
to support v2_01a version of IP. 3.01a bss 10/25/12 Deleted
XAxiPmon_EnableCountersData API to support new version of IP. 5.00a bss 10/25/12
Modified call to XAxiPmon_SetSampleInterval as per new driver API. 6.4 mus
01/07/16 Added support for ZynqMP interrupt controller 6.5 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipmon/examples/xaxipmon_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon_ocm_example.c This
file contains a design example showing how to use the driver APIs of the AXI
Performance Monitor driver to measure the following metrics captured at OCM of
Zynq MP: - Write Transcation Count - Write Byte Count - Read Transcation Count -
Read Byte Count <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.00a bss 04/01/15 First release 6.5 sg 11/02/16 Updated device ID to
OCM PSU APM ID ms 01/23/17 Modified xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipmon/examples/xaxipmon_ocm_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon_polled_example.c This
file contains a design example showing how to use the driver APIs of the AXI
Performance Monitor driver in poll mode. @note Global Clock Counter and Metric
Counters are enabled. The Application for which Metrics need to be computed
should be run and then the Metrics collected. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a bss 02/29/12 First release 2.00a bss
06/23/12 Updated to support v2_00a version of IP. 3.00a bss 09/03/12 Deleted
XAxiPmon_SetAgent API to support v2_01a version of IP. 3.01a bss 10/25/12
Deleted XAxiPmon_EnableCountersData API to support new version of IP. 6.5 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipmon/examples/xaxipmon_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon.c @addtogroup
axipmon_v6_6 @{ This file contains the driver API functions that can be used to
access the AXI Performance Monitor device. Refer to the xaxipmon.h header file
for more information about this driver. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ----- -------- 1.00a bss 02/27/12 First release 2.00a
bss 06/23/12 Updated to support v2_00a version of IP. 3.00a bss 09/03/12 Deleted
XAxiPmon_SetAgent, XAxiPmon_GetAgent APIs and modified XAxiPmon_SetMetrics,
XAxiPmon_GetMetrics APIs to support v2_01a version of IP. 3.01a bss 10/25/12
Added XAxiPmon_StartCounters and XAxiPmon_StopCounters APIs (CR 683799). Added
XAxiPmon_StartEventLog and XAxiPmon_StopEventLog APIs (CR 683801). Added
XAxiPmon_GetMetricName API (CR 683803). Modified XAxiPmon_SetMetrics and
XAxiPmon_GetMetrics (CR 683746) Added XAxiPmon_EnableEventLog,
XAxiPmon_DisableMetricsCounter, XAxiPmon_EnableMetricsCounter APIs to replace
macros. Added XAxiPmon_SetMetricCounterCutOff, XAxiPmon_GetMetricCounterCutOff,
XAxiPmon_EnableExternalTrigger and XAxiPmon_DisableExternalTrigger APIs to
support new version of IP. 4.00a bss 01/17/13 To support new version of IP:
Added XAxiPmon_SetLogEnableRanges, XAxiPmon_GetLogEnableRanges,
XAxiPmon_EnableMetricCounterTrigger, XAxiPmon_DisableMetricCounterTrigger,
XAxiPmon_EnableEventLogTrigger, XAxiPmon_DisableEventLogTrigger,
XAxiPmon_SetWriteLatencyId, XAxiPmon_SetReadLatencyId,
XAxiPmon_GetWriteLatencyId, XAxiPmon_GetReadLatencyId APIs and removed
XAxiPmon_SetMetricCounterCutOff, XAxiPmon_GetMetricCounterCutOff,
XAxiPmon_EnableExternalTrigger and XAxiPmon_DisableExternalTrigger APIs 5.00a
bss 08/26/13 To support new version of IP: Modified XAxiPmon_CfgInitialize to
add Mode of APM and ScaleFactor parameter. Modified Assert functions depending
on Mode. Modified XAxiPmon_GetMetricCounter and XAxiPmon_GetSampledMetricCounter
to include new Counters. Modified XAxiPmon_SetSampleInterval and
XAxiPmon_GetSampleInterval to remove higher 32 bit value of SampleInterval since
Sample Interval Register is only 32 bit. Added XAxiPmon_SetWrLatencyStart,
XAxiPmon_SetWrLatencyEnd, XAxiPmon_SetRdLatencyStart XAxiPmon_SetRdLatencyEnd,
XAxiPmon_GetWrLatencyStart, XAxiPmon_GetWrLatencyEnd,
XAxiPmon_GetRdLatencyStart, XAxiPmon_GetRdLatencyEnd, XAxiPmon_SetWriteIdMask,
XAxiPmon_SetReadIdMask, XAxiPmon_GetWriteIdMask and XAxiPmon_GetReadIdMask APIs.
Renamed: XAxiPmon_SetWriteLatencyId to XAxiPmon_SetWriteId
XAxiPmon_SetReadLatencyId to XAxiPmon_SetReadId XAxiPmon_GetWriteLatencyId to
XAxiPmon_GetWriteId XAxiPmon_SetReadLatencyId to XAxiPmon_GetReadId. 6.2 bss
04/21/14 Updated XAxiPmon_CfgInitialize to Reset counters and FIFOs based on
Modes(CR782671). And if both profile and trace modes are present set mode as
Advanced. 6.2 bss 03/02/15 Updated XAxiPmon_SetWriteId, XAxiPmon_SetReadId,
XAxiPmon_GetWriteId, XAxiPmon_GetReadId XAxiPmon_SetWriteIdMask,
XAxiPmon_SetReadIdMask, XAxiPmon_GetWriteIdMask, XAxiPmon_GetReadIdMask
functions to support Zynq MP APM. 6.3 kvn 07/02/15 Modified code according to
MISRA-C:2012 guidelines. 6.4 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototype of XAxiPmon_CfgInitialize API. 6.7
sd 17/11/18 Fix Doxygen reported warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipmon/src/xaxipmon.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon.h @addtogroup
axipmon_v6_6 @{ @details The XAxiPmon driver supports the Xilinx AXI Performance
Monitor device. The AXI Performance Monitor device provides following features:
Configurable number of Metric Counters and Incrementers Computes performance
metrics for Agents connected to monitor slots (Up to 8 slots) The following
Metrics can be computed: Metrics computed for an AXI4 MM agent: Write Request
Count: Total number of write requests by/to the agent. Read Request Count: Total
number of read requests given by/to the agent. Read Latency: It is defined as
the time from the start of read address transaction to the beginning of the read
data service. Write Latency: It is defined as the period needed a master
completes write data transaction, i.e. from write address transaction to write
response from slave. Write Byte Count: Total number of bytes written by/to the
agent. This metric is helpful when calculating the throughput of the system.
Read Byte Count: Total number of bytes read from/by the agent. Average Write
Latency: Average write latency seen by the agent. It can be derived from total
write latency and the write request count. Average Read Latency: Average read
latency seen by the agent. It can be derived from total read latency and the
read request count. Master Write Idle Cycle Count: Number of idle cycles caused
by the masters during write transactions to the slave. Slave Write Idle Cycle
Count: Number of idle cycles caused by this slave during write transactions to
the slave. Master Read Idle Cycle Count: Number of idle cycles caused by the
master during read transactions to the slave. Slave Read Idle Cycle Count:
Number of idle cycles caused by this slave during read transactions to the
slave. Metrics computed for an AXI4-Stream agent: Transfer Cycle Count: Total
number of writes by/to the agent. Data Byte Count: Total number of data bytes
written by/to the agent. This metric helps in calculating the throughput of the
system. Position Byte Count: Total number of position bytes transferred. Null
Byte Count: Total number of null bytes transferred. Packet Count: Total number
of packets transferred. There are three modes : Advanced, Profile and Trace. -
Advanced mode has 10 Mertic Counters, Sampled Metric Counters, Incrementors and
Sampled Incrementors. - Profile mode has only 47 Metric Counters and Sampled
Metric Counters. - Trace mode has no Counters. User should refer to the hardware
device specification for detailed information about the device. This header file
contains the prototypes of driver functions that can be used to access the AXI
Performance Monitor device. <b> Initialization and Configuration </b> The device
driver enables higher layer software (e.g., an application) to communicate to
the AXI Performance Monitor device. XAxiPmon_CfgInitialize() API is used to
initialize the AXI Performance Monitor device. The user needs to first call the
XAxiPmon_LookupConfig() API which returns the Configuration structure pointer
which is passed as a parameter to the XAxiPmon_CfgInitialize() API.
<b>Interrupts</b> The AXI Performance Monitor does not support Interrupts <b>
Virtual Memory </b> This driver supports Virtual Memory. The RTOS is responsible
for calculating the correct device base address in Virtual Memory space. <b>
Threads </b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver. <b> Asserts
</b> Asserts are used within all Xilinx drivers to enforce constraints on
argument values. Asserts can be turned off on a system-wide basis by defining,
at compile time, the NDEBUG identifier. By default, asserts are turned on and it
is recommended that users leave asserts on during development. <b> Building the
driver </b> The XAxiPmon driver is composed of several source files. This allows
the user to build and link only those parts of the driver that are necessary.
<b> Limitations of the driver </b> <br><br> <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ----- -------- 1.00a bss 02/27/12 First release 2.00a bss
06/23/12 Updated to support v2_00a version of IP. 3.00a bss 09/03/12 To support
v2_01_a version of IP: Deleted XAxiPmon_SetAgent, XAxiPmon_GetAgent APIs and
added XAPM_FLAG_EVENT, XAPM_FLAG_EVNTSTAR, XAPM_FLAG_EVNTSTOP. Deleted
XAxiPmon_SetAgent, XAxiPmon_GetAgent APIs and modified XAxiPmon_SetMetrics,
XAxiPmon_GetMetrics APIs in xaxipmon.c Deleted XAPM_AGENT_OFFSET Macro in
xaxipmon_hw.h 3.01a bss 10/25/12 To support new version of IP: Added
XAPM_MCXLOGEN_OFFSET macros in xaxipmon_hw.h. Added
XAxiPmon_SetMetricCounterCutOff, XAxiPmon_GetMetricCounterCutOff,
XAxiPmon_EnableExternalTrigger and XAxiPmon_DisableExternalTrigger APIs in
xaxipmon.c Modified XAxiPmon_SetMetrics and XAxiPmon_GetMetrics (CR 683746) in
xaxipmon.c Added XAxiPmon_EnableEventLog, XAxiPmon_DisableMetricsCounter,
XAxiPmon_EnableMetricsCounter APIs in xaxipmon.c to replace macros in this file.
Added XAPM_FLAG_XXX macros. Added XAxiPmon_StartCounters and
XAxiPmon_StopCounters APIs (CR 683799). Added XAxiPmon_StartEventLog and
XAxiPmon_StopEventLog APIs (CR 683801). Added XAxiPmon_GetMetricName API (CR
683803). Deleted XAxiPmon_SetAgent, XAxiPmon_GetAgent declarations (CR 677337)
4.00a bss 01/17/13 To support new version of IP: Added XAPM_METRIC_SET_12 to
XAPM_METRIC_SET_15 macros. Added XAxiPmon_SetLogEnableRanges,
XAxiPmon_GetLogEnableRanges, XAxiPmon_EnableMetricCounterTrigger,
XAxiPmon_DisableMetricCounterTrigger, XAxiPmon_EnableEventLogTrigger,
XAxiPmon_DisableEventLogTrigger, XAxiPmon_SetWriteLatencyId,
XAxiPmon_SetReadLatencyId, XAxiPmon_GetWriteLatencyId, XAxiPmon_GetReadLatencyId
APIs and removed XAxiPmon_SetMetricCounterCutOff,
XAxiPmon_GetMetricCounterCutOff, XAxiPmon_EnableExternalTrigger and
XAxiPmon_DisableExternalTrigger APIs in xaxipmon.c Added XAPM_LATENCYID_OFFSET,
XAPM_CR_EVTLOG_EXTTRIGGER_MASK, XAPM_LATENCYID_RID_MASK and
XAPM_LATENCYID_WID_MASK in xaxipmon_hw.h 5.00a bss 08/26/13 To support new
version of IP: XAxiPmon_SampleMetrics Macro. Modified XAxiPmon_CfgInitialize,
Assert functions Added XAxiPmon_GetMetricCounter, XAxiPmon_SetSampleInterval,
XAxiPmon_GetSampleInterval, XAxiPmon_SetWrLatencyStart,
XAxiPmon_SetWrLatencyEnd, XAxiPmon_SetRdLatencyStart, XAxiPmon_SetRdLatencyEnd,
XAxiPmon_GetWrLatencyStart, XAxiPmon_GetWrLatencyEnd,
XAxiPmon_GetRdLatencyStart, XAxiPmon_GetRdLatencyEnd, XAxiPmon_SetWriteIdMask,
XAxiPmon_SetReadIdMask, XAxiPmon_GetWriteIdMask and XAxiPmon_GetReadIdMask APIs
Renamed : XAxiPmon_SetWriteLatencyId to XAxiPmon_SetWriteId,
XAxiPmon_SetReadLatencyId to XAxiPmon_SetReadId, XAxiPmon_GetWriteLatencyId to
XAxiPmon_GetWriteId and XAxiPmon_SetReadLatencyId to XAxiPmon_GetReadId. in
xaxipmon.c Added Macros XAPM_MC10_OFFSET to XAPM_MC47_OFFSET, XAPM_SMC10_OFFSET
to XAPM_SMC47_OFFSET, XAPM_IDMASK_OFFSET, XAPM_CR_IDFILTER_ENABLE_MASK,
XAPM_CR_WRLATENCY_START_MASK, XAPM_CR_WRLATENCY_END_MASK,
XAPM_CR_RDLATENCY_START_MASK, XAPM_CR_RDLATENCY_END_MASK and
XAPM_MAX_COUNTERS_PROFILE. Renamed: XAPM_LATENCYID_OFFSET to XAPM_ID_OFFSET,
XAPM_LATENCYID_RID_MASK to XAPM_ID_RID_MASK, XAPM_LATENCYID_WID_MASK to
XAPM_ID_WID_MASK. in xaxipmon_hw.h. Modified driver tcl to generate new
parameters ScaleFactor, ModeProfile, ModeTrace and ModeAdvanced in Config
structure. 6.0 adk 19/12/13 Updated as per the New Tcl API's 6.1 adk 16/04/14
Updated the driver tcl for the newly added parameters in The Axi pmon IP. 6.2
bss 04/21/14 Updated XAxiPmon_CfgInitialize in xaxipmon.c to Reset counters and
FIFOs based on Modes(CR782671). And if both profile and trace modes are present
set mode as Advanced. 6.2 bss 03/02/15 To support Zynq MP APM: Added
Is32BitFiltering in XAxiPmon_Config structure. Updated XAxiPmon_SetWriteId,
XAxiPmon_SetReadId, XAxiPmon_GetWriteId, XAxiPmon_GetReadId
XAxiPmon_SetWriteIdMask, XAxiPmon_SetReadIdMask XAxiPmon_GetWriteIdMask,
XAxiPmon_GetReadIdMask functions in xaxipmon.c. Added XAPM_RID_OFFSET and
XAPM_RIDMASK_OFFSET in xaxipmon_hw.h 6.3 kvn 07/02/15 Modified code according to
MISRA-C:2012 guidelines. 6.4 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototype of XAxiPmon_CfgInitialize API. 6.5
ms 01/23/17 Modified xil_printf statement in main function for all examples to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. 6.6 ms 04/18/17 Modified tcl file to add
suffix U for all macro definitions of axipmon in xparameters.h </pre>

FILES:
XilinxProcessorIPLib/drivers/axipmon/src/xaxipmon.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon_g.c @addtogroup
axipmon_v6_6 @{ This file contains a configuration table that specifies the
configuration of AxiMon devices in the system. See xaxipmon.h for more
information about this driver. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ----- -------- 1.00a bss 02/22/12 First release 2.00a bss
06/23/12 Updated to support v2_00a version of IP. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipmon/src/xaxipmon_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon_hw.h @addtogroup
axipmon_v6_6 @{ This header file contains identifiers and basic driver functions
(or macros) that can be used to access the AXI Performance Monitor. Refer to the
device specification for more information about this driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a bss
02/27/12 First release 2.00a bss 06/23/12 Updated to support v2_00a version of
IP. 3.00a bss 09/03/12 Deleted XAPM_AGENT_OFFSET Macro to support v2_01a version
of IP. 3.01a bss 10/25/12 To support new version of IP: Added
XAPM_MCXLOGEN_OFFSET and XAPM_CR_EXTERNAL_TRIGGER_MASK macros. 4.00a bss
01/17/13 To support new version of IP: Added XAPM_LATENCYID_OFFSET,
XAPM_CR_EVTLOG_EXTTRIGGER_MASK, XAPM_LATENCYID_RID_MASK and
XAPM_LATENCYID_WID_MASK 5.00a bss 08/26/13 To support new version of IP: Added
Macros XAPM_MC10_OFFSET to XAPM_MC47_OFFSET, XAPM_SMC10_OFFSET to
XAPM_SMC47_OFFSET. Added macro XAPM_IDMASK_OFFSET, XAPM_SR_OFFSET. Added
XAPM_CR_IDFILTER_ENABLE_MASK, XAPM_CR_WRLATENCY_START_MASK,
XAPM_CR_WRLATENCY_END_MASK, XAPM_CR_RDLATENCY_START_MASK,
XAPM_CR_RDLATENCY_END_MASK, XAPM_MASKID_RID_MASK and XAPM_MASKID_WID_MASK
macros. Renamed: XAPM_LATENCYID_OFFSET to XAPM_ID_OFFSET,
XAPM_LATENCYID_RID_MASK to XAPM_ID_RID_MASK, XAPM_LATENCYID_WID_MASK to
XAPM_ID_WID_MASK. 6.2 bss 03/02/15 Added XAPM_RID_OFFSET and XAPM_RIDMASK_OFFSET
to support Zynq MP APM. 6.3 kvn 07/02/15 Modified code according to MISRA-C:2012
guidelines. </pre>

FILES:
XilinxProcessorIPLib/drivers/axipmon/src/xaxipmon_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon_selftest.c @addtogroup
axipmon_v6_6 @{ This file contains a diagnostic self test function for the
XAxiPmon driver. The self test function does a simple read/write test of the
Alarm Threshold Register. See XAxiPmon.h for more information. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a bss
02/24/12 First release 2.00a bss 06/23/12 Updated to support v2_00a version of
IP. 6.3 kvn 07/02/15 Modified code according to MISRA-C:2012 guidelines. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipmon/src/xaxipmon_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxipmon_sinit.c @addtogroup
axipmon_v6_6 @{ This file contains the implementation of the XAxiPmon driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a bss 02/27/12 First release 2.00a bss
06/23/12 Updated to support v2_00a version of IP. 6.3 kvn 07/02/15 Modified code
according to MISRA-C:2012 guidelines. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axipmon/src/xaxipmon_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxis_switch_example.c This
file demonstrates the use AXI4-Stream Switch Control Router driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00 sha 01/28/15
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axis_switch/examples/xaxis_switch_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxis_switch.c @addtogroup
axis_switch_v1_2 @{ This is the main file for Xilinx AXI4-Stream Switch Control
Router core. Please see xaxis_switch.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00 sha 01/28/15
Initial release. 1.1 sk 08/16/16 Used UINTPTR instead of u32 for Baseaddress as
part of adding 64 bit support. CR 867425. Changed the prototype of
XAxisScr_CfgInitialize API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axis_switch/src/xaxis_switch.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxis_switch.h @addtogroup
axis_switch_v1_2 @{ @details This is the main header file for Xilinx AXI4-Stream
Switch Control Router core. It is used for routing streams where masters in the
system do not know final destination address. <b>Core Features </b> For a full
description of AXI4-Stream Switch Control Router, please see the hardware
specification. <b>Software Initialization & Configuration</b> The application
needs to do following steps in order for preparing the AXI4-Stream Switch
Control Router core to be ready. - Call XAxisScr_LookupConfig using a device ID
to find the core configuration. - Call XAxisScr_CfgInitialize to initialize the
device and the driver instance associated with it. <b>Interrupts </b> This
driver does not have interrupt mechanism. <b> Virtual Memory </b> This driver
supports Virtual Memory. The RTOS is responsible for calculating the correct
device base address in Virtual Memory space. <b> Threads </b> This driver is not
thread safe. Any needs for threads or thread mutual exclusion must be satisfied
by the layer above this driver. <b> Asserts </b> Asserts are used within all
Xilinx drivers to enforce constraints on argument values. Asserts can be turned
off on a system-wide basis by defining at compile time, the NDEBUG identifier.
By default, asserts are turned on and it is recommended that users leave asserts
on during development. <b> Building the driver </b> The XAXI4-Stream Switch
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.00 sha 01/28/15 Initial
release. 1.1 sk 08/16/16 Used UINTPTR instead of u32 for Baseaddress as part of
adding 64 bit support. CR 867425. Changed the prototype of
XAxisScr_CfgInitialize API. 1.2 ms 02/20/17 Fixed compilation warning in
_sinit.c file. This is a fix for CR-969126. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/axis_switch/src/xaxis_switch.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxis_switch_g.c @addtogroup
axis_switch_v1_2 @{ This file gets generated automatically by HSI. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 07/15/15
Added XPAR_XAXIS_SWITCH_NUM_INSTANCES macro to control config table parameters.
Modified copyright header. Added doxygen tag and modification history. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/axis_switch/src/xaxis_switch_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxis_switch_hw.h @addtogroup
axis_switch_v1_2 @{ This header file contains identifiers and register-level
core functions (or macros) that can be used to access the Xilinx AXI4-Stream
Switch Control Router core. For more information about the operation of this
core see the hardware specification and documentation in the higher level driver
xaxis_switch.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00 sha 01/28/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/axis_switch/src/xaxis_switch_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxis_switch_selftest.c
@addtogroup axis_switch_v1_2 @{ This file contains self test function for the
AXI4-Stream Source Control Router core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00 sha 01/28/15 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/axis_switch/src/xaxis_switch_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxis_switch_sinit.c
@addtogroup axis_switch_v1_2 @{ This file contains static initialization method
for Xilinx AXI4-Stream Source Control Router core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- --- -------- 1.00 sha 01/28/15 Initial release. 1.00
sha 07/15/15 Defined macro XPAR_XAXIS_SWITCH_NUM_INSTANCES if not defined in
xparameters.h 1.2 ms 02/20/17 Fixed compilation warning. This is a fix for
CR-969126. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axis_switch/src/xaxis_switch_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file axivdma_v2_1_0.tcl <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 3.00a srt
08/26/11 Added new parameters for Flush on Frame Sync and Line Buffer
Thresholds. 4.00a srt 11/21/11 Added new parameters for Genlock Source and Fsync
Source Selection. 4.03a srt 01/18/13 Added TDATA_WIDTH parameters (CR: 691866)
4.04a srt 03/01/13 Added DEBUG_INFO parameters (CR: 703738) 4.05a srt 05/01/3
Merged v4.03a driver with v4.04a driver. Driver v4.03a - Supports VDMA IPv5.04a
XPS release Driver v4.04a - Supports VDMA IPv6.00a IPI release The parameters
C_ENABLE_DEBUG_ are only available in VDMA IPv6.00a. These parameters should be
set to '1' for older versions of IP (XPS) and added this logic in this file. 5.0
adk 10/12/13 Updated as per the New Tcl API's 6.4 ms 04/17/17 Modified tcl file
to add suffix U for all macros definitions of axivdma in xparameters.h </pre>
uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/axivdma/data/axivdma.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file vdma.c This file comprises
sample application to usage of VDMA APi's in vdma_api.c. . MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 4.0 adk 11/26/15 First release 4.1 adk
01/07/16 Updated DDR base address for Ultrascale (CR 799532) and removed the
defines for S6/V6. ms 04/05/17 Modified Comment lines in functions to recognize
it as documentation block for doxygen generation of examples. / Include file /

FILES:
XilinxProcessorIPLib/drivers/axivdma/examples/vdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file vdma_api.c This file has high
level API to configure and start the VDMA.The file assumes that: The design has
VDMA with both MM2S and S2MM path enable. The API's has tested with hardware
that has tow VDMA and MM2S to S2MM are back to back connected for each VDMA.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 4.0 adk 11/26/15
First release /

FILES:
XilinxProcessorIPLib/drivers/axivdma/examples/vdma_api.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_example_intr.c This
example demonstrates how to use the AXI Video DMA with other video IPs to do
video frame transfers. This example does not work by itself. It needs two other
Video IPs, one for writing video frames to the memory and one for reading video
frames from the memory. To see the debug print, you need a Uart16550 or uartlite
in your system, and please set "-DDEBUG" in your compiler options. You need to
rebuild your software executable. @note The values of DDR_BASE_ADDR and
DDR_HIGH_ADDR should be as per the HW system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a jz 07/26/10 First release 1.01a jz
09/26/10 Updated callback function signature 2.00a jz 12/10/10 Added support for
direct register access mode, v3 core 2.01a rvp 01/22/11 Renamed the example file
to be consistent Added support to the example to use SCU GIC interrupt
controller for ARM, some functions in this example have changed. rkv 03/28/11
Updated to support for frame store register. 3.00a srt 08/26/11 Added support
for Flush on Frame Sync Feature. 4.00a srt 03/06/12 Modified interrupt support
for Zynq. 4.02a srt 09/25/12 Fixed CR 677704 Description - Arguments misused in
function XAxiVdma_IntrEnable(). 4.03a srt 03/01/13 Updated DDR base address for
IPI designs (CR 703656). 6.2 ms 01/23/17 Modified xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. 6.5 rsp 12/01/17 Set TX/RX
framebuffer count to IP default. CR-990409 6.6 rsp 07/02/18 Set Vertical Flip
state to IP default. CR-989453 </pre> /

FILES:
XilinxProcessorIPLib/drivers/axivdma/examples/xaxivdma_example_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_example_selftest.c
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 6.2 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 04/05/17 Modified Comment lines in functions to recognize
it as documentation block for doxygen generation of examples. 6.5 rsp 05/12/17
Fix compilation error.Rename macro for dma device id. CR-990803 </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/axivdma/examples/xaxivdma_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma.c @addtogroup
axivdma_v6_6 @{ Implementation of the driver API functions for the AXI Video DMA
engine. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a jz 08/16/10 First release 2.00a jz 12/10/10 Added support for direct
register access mode, v3 core 2.01a jz 01/19/11 Added ability to re-assign BD
addresses rkv 03/28/11 Added support for frame store register. 3.00a srt
08/26/11 Added support for Flush on Frame Sync and dynamic programming of Line
Buffer Thresholds and added API XAxiVdma_SetLineBufThreshold. 4.00a srt 11/21/11
- XAxiVdma_CfgInitialize API is modified to use the EffectiveAddr. - Added APIs:
XAxiVdma_FsyncSrcSelect() XAxiVdma_GenLockSourceSelect() 4.01a srt 06/13/12 -
Added APIs: XAxiVdma_GetDmaChannelErrors() XAxiVdma_ClearDmaChannelErrors()
4.02a srt 09/25/12 - Fixed CR 678734 XAxiVdma_SetFrmStore function changed to
remove Reset logic after setting number of frame stores. 4.03a srt 01/18/13 -
Updated logic of GenLockSourceSelect() & FsyncSrcSelect() APIs for newer
versions of IP (CR: 691052). - Modified CfgInitialize() API to initialize
StreamWidth parameters. (CR 691866) 4.04a srt 03/03/13 - Support for
_ENABLE_DEBUG_INFO_ debug configuration parameters (CR: 703738) 6.1 sk 11/10/15
Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototype of
XAxiVdma_CfgInitialize API. 6.6 rsp 07/02/18 Add Vertical flip support. Populate
"HasVFlip" from XAxiVdma_Config(CR-989453) </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma.h @addtogroup
axivdma_v6_6 @{ @details This is the Xilinx MVI AXI Video DMA device driver. The
DMA engine transfers frames from the AXI Bus or to the AXI Bus. It is in the
chain of video IPs, which process video frames. It supports the following
features: - Continuous transfers of video frames, AKA circular buffer mode -
Continuous transfers of one specific video frame, AKA park mode - Optionally
only transfer a certain amount of video frames - Optionally transfer unaligned
frame buffers An AXI Video DMA engine can have one or two channels. If
configured as two channels, then one of the channels reads data from memory, and
the other channel writes to the memory. For a full description of AXI Video DMA
features, please see the hardware spec. The driver composes of three parts:
initialization, start a DMA transfer, and interrupt handling. <b> Driver
Initialization </b> To initialize the driver, the caller needs to pass a
configuration structure to the driver. This configuration structure contains
information about the hardware build. A caller can manually setup the
configuration structure, or call XAxiVdma_LoopkupConfig(). The sequence of
initialization of the driver is: 1. XAxiVdma_LookupConfig() to get the
configuration structure, or manually setup the structure. 2.
XAxiVdma_CfgInitialize() to initialize the driver & device. 3.
XAxiVdma_SetFrmStore() to set the desired frame store number which is optional.
4. If interrupt is desired: - Set frame counter using XAxiVdma_SetFrameCounter()
- Set call back functions for each channel. There are two types of call
backfunctions: general and error - Enable interrupts that the user cares about
<b>Start a DMA Transaction </b> If you are using the driver API to start the
transfer, then there are two ways to start a DMA transaction: 1. Invoke
XAxiVdma_StartWriteFrame() or XAxiVdma_StartReadFrame() to start a DMA
operation, depending on the purpose of the transfer (Read or Write). 2. Or, call
the phased functions as the following: - Call XAxiVdma_DmaConfig() to set up a
DMA operation configuration - Call XAxiVdma_DmaSetBufferAddr() to set up the DMA
buffers - Call XAxiVdma_DmaStart() to kick off the DMA operation If you are
writing your own functions to start the transfer, the order of setting up the
hardware must be the following: - Do any processing or setting, but do not start
the hardware, means do not set the RUN/STOP bit in the XAXIVDMA_CR_OFFSET
register. - After any reset you need to do, write the head of your BD ring into
the XAXIVDMA_CDESC_OFFSET register. - You can do other setup for the hardware. -
Start your hardware, by setting up the RUN/STOP bit in the XAXIVDMA_CR_OFFSET
register. - You can do other setup for the hardware. - If you are done with all
the setup, now write the tail of your BD ring to the XAXIVDMA_TDESC_OFFSET
register to start the transfer. You can refer to XAxiVdma_ChannelStartTransfer()
to see how this order is preserved there. The function is in xaxivdma_channel.c.
Note a Read VDMA could work with one out of multiple write VDMA instances and
vice versa. The PointNum in structure XAxiVdma_DmaSetup decides which VDMA
instance this VDMA is working with. <b>Interrupt Handling </b> Each VDMA channel
supports 2 kinds of interrupts: - General Interrupt: An interrupt other than
error interrupt. - Error Interrupt: An error just happened. The driver does the
interrupt handling, and dispatch to the user application through callback
functions that user has registered. If there are no registered callback
functions, then a stub callback function is called. Each channel has two
interrupt callback functions. One for IOC and delay interrupt, or general
interrupt; one for error interrupt. <b>Reset</b> Reset a DMA channel causes the
channel enter the following state: - Interrupts are disabled - Coalescing
threshold is one - Delay counter is 0 - RUN/STOP bit low - Halted bit high -
XAXIVDMA_CDESC_OFFSET register has 0 - XAXIVDMA_TDESC_OFFSET register has 0 If
there is an active transfer going on when reset (or stop) is issued to the
hardware, the current transfer will gracefully finish. For a maximum transfer
length of (0x1FFF 0xFFFF) bytes, on a 100 MHz system, it can take as long as
1.34 seconds, assuming that the system responds to DMA engine's requests
quickly. To ensure that the hardware finishes the reset, please use
XAxiVdma_ResetNotDone() to check for completion of the reset. To start a
transfer after a reset, the following actions are the minimal requirement before
setting RUN/STOP bit high to avoid crashing the system: - XAXIVDMA_CDESC_OFFSET
register has a valid BD pointer, it should be the head of the BD ring. -
XAXIVDMA_TDESC_OFFSET register has a valid BD pointer, it should be the tail of
the BD ring. If you are using the driver API to start a transfer after a reset,
then it should be fine. <b>Stop</b> Stop a channel using XAxiVDma_DmaStop() is
similar to a reset, except the registers are kept intact. To start a transfer
after a stop: - If there are error bits in the status register, then a reset is
necessary. Please refer to the <b>Reset</b> section for more details on how to
start a transfer after a reset. - If there are no error bits in the status
register, then you can call XAxiVdma_DmaStart() to start the transfer again.
Note that the transfer always starts from the first video frame. <b>
Examples</b> We provide one example on how to use the AXI VDMA with AXI Video
IPs. This example does not work by itself. To make it work, you must have two
other Video IPs to connect to the VDMA. One of the Video IP does the write and
the other does the read. <b>Cache Coherency</b> This driver does not handle any
cache coherency for the data buffers. The application is responsible for
handling cache coherency, if the cache is enabled. <b>Alignment</b> The VDMA
supports any buffer alignment when DRE is enabled in the hardware configuration.
It only supports word-aligned buffers otherwise. Note that "word" is defined by
C_M_AXIS_MM2S_TDATA_WIDTH and C_S_AXIS_S2MM_TDATA_WIDTH for the read and write
channel specifically. If the horizontal frame size is not word-aligned, then DRE
must be enabled in the hardware. Otherwise, undefined results happen. <b>Address
Translation</b> Buffer addresses for transfers are physical addresses. If the
system does not use MMU, then physical and virtual addresses are the same.
<b>API Change from PLB Video DMA</b> We try to keep the API as consistent with
the PLB Video DMA driver as possible. However, due to hardware differences, some
of the PLB video DMA driver APIs are changed or removed. Two API functions are
added to the AXI DMA driver. For details on the API changes, please refer to
xaxivdma_porting_guide.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a jz 08/16/10 First release 2.00a jz 12/10/10 Added support
for direct register access mode, v3 core 2.01a jz 01/19/11 Added ability to re-
assign BD addresses Replaced include xenv.h with string.h in xaxivdma_i.h file.
2.01a rkv 03/28/11 Added support for frame store register and
XAxiVdma_ChannelInit API is changed. 3.00a srt 08/26/11 - Added support for
Flush on Frame Sync and dynamic programming of Line Buffer Thresholds. -
XAxiVdma_ChannelErrors API is changed to support for Flush on Frame Sync
feature. - Two flags, XST_VDMA_MISMATCH_ERROR & XAXIVDMA_MIS MATCH_ERROR are
added to report error status when Flush on Frame Sync feature is enabled. 4.00a
srt 11/21/11 - XAxiVdma_ChannelSetBufferAddr API is changed to support 32 Frame
Stores. - XAxiVdma_ChannelConfig API is changed to support modified Park Offset
Register bits. - Added APIs: XAxiVdma_FsyncSrcSelect()
XAxiVdma_GenLockSourceSelect() - Modified structures XAxiVdma_Config and
XAxiVdma to include new parameters. 4.01a srt 06/13/12 - Added APIs:
XAxiVdma_GetDmaChannelErrors() XAxiVdma_ClearDmaChannelErrors()
XAxiVdma_ClearChannelErrors() - XAxiVdma_ChannelErrors API is changed to remove
Mismatch error logic. - Removed Error checking logic in the channel APIs.
Provided User APIs to do this. - Added new error bit mask
XAXIVDMA_SR_ERR_SOF_LATE_MASK - XAXIVDMA_MISMATCH_ERROR flag is deprecated. -
Modified the logic of Error handling in interrupt handlers. 4.02a srt 10/11/12 -
XAxiVdma_SetFrmStore function changed to remove Reset logic after setting number
of frame stores. (CR 678734) - Changed Error bitmasks to support IP version
5.02a. (CR 679959) 4.03a srt 01/18/13 - Updated logic of GenLockSourceSelect() &
FsyncSrcSelect() APIs for newer versions of IP (CR: 691052). - Modified
CfgInitialize() API to initialize StreamWidth parameters and added TDATA_WIDTH
parameters to tcl file (CR 691866) - Updated DDR base address for IPI designs
(CR 703656). 4.04a srt 03/03/13 - Support for the GenlockRepeat Control bit (Bit
15) added in the new version of IP v5.04 (CR: 691391) - Updated driver tcl,
xaxivdma_g.c and XAxiVdma_Config structure in xaxivdma.h to import the relevant
VDMA IP DEBUG_INFO_ parameters into the driver. This fixes CR 703738. 4.05a srt
05/01/3 - Merged v4.03a driver with v4.04a driver. Driver v4.03a - Supports VDMA
IPv5.04a XPS release Driver v4.04a - Supports VDMA IPv6.00a IPI release The
parameters C_ENABLE_DEBUG_ are only available in VDMA IPv6.00a. These parameters
should be set to '1' for older versions of IP (XPS) and added this logic in the
driver tcl file. - Added unalignment checks for Hsize and Stride (CR 710279)
4.06a srt 04/09/13 - Added support for the newly added S2MM_DMA_IRQ_MASK
register (CR 734741) 5.0 adk 19/12/13 - Updated as per the New Tcl API's 5.1 adk
20/01/15 Added support for peripheral test. Created the self test example to
include it on peripheral test's(CR823144). 5.1 adk 29/01/15 Added the sefltest
api (XAxiVdma_Selftest) to the driver source files (xaxivdma_selftest.c) and
called this from the selftest example 6.0 vak 27/07/15 Added example for
demonstarting triple buffer api. 6.0 vak 27/07/15 Added 64 bit addressing
support to the driver. 6.0 vak 26/08/15 Added checks to align hsize and stride
based on channel direction (read or write)(CR 874861) 6.1 sk 11/10/15 Used
UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototype of
XAxiVdma_CfgInitialize API. 6.2 ms 01/23/17 Modified xil_printf statement in
main function for all examples to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. 6.3 ms
02/20/17 Fixed compilation error in xaxivdma_intr.c. CR-969129. ms 03/17/17
Modified the text file in examples folder for doxygen generation. ms 04/05/17
Modified Comment lines in functions of axivdma examples to recognize it as
documentation block for doxygen generation of examples. 6.4 ms 04/18/17 Modified
tcl file to add suffix U for all macro definitions of axivdma in xparameters.h
ms 08/07/17 Fixed compilation warnings in xaxivdma_sinit.c 6.6 rsp 07/02/18 Add
vertical flip states in config structures </pre>

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_channel.c @addtogroup
axivdma_v6_6 @{ Implementation of the channel related functions. These functions
are used internally by the driver, and are declared in xaxivdma_i.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 08/16/10
First release 2.00a jz 12/10/10 Added support for direct register access mode,
v3 core 2.01a jz 01/19/11 Added ability to re-assign BD addresses rkv 03/28/11
XAxiVdma_ChannelInit API is changed. 3.02a srt 08/26/11 - XAxiVdma_ChannelErrors
API is changed to support for Flush on Frame Sync feature. - Two flags,
XST_VDMA_MISMATCH_ERROR & XAXIVDMA_MIS MATCH_ERROR are added to report error
status when Flush on Frame Sync feature is enabled. 4.00a srt 11/21/11 -
XAxiVdma_ChannelSetBufferAddr API is changed to support 32 Frame Stores. -
XAxiVdma_ChannelConfig API is changed to support modified Park Offset Register
bits. - Added APIs: XAxiVdma_ChannelHiFrmAddrEnable()
XAxiVdma_ChannelHiFrmAddrDisable() 4.01a srt 06/13/12 - Added API:
XAxiVdma_ClearChannelErrors() XAxiVdma_ChannelGetEnabledIntr() -
XAxiVdma_ChannelErrors API is changed to remove Mismatch error logic. - Removed
Error checking logic in the APIs. Provided User APIs to do this. 4.04a srt
03/03/13 - Changes for IPv5.04a: Support for the GenlockRepeat Control bit (Bit
15) (CR: 691391) - Support for _ENABLE_DEBUG_INFO_ debug configuration
parameters (CR: 703738) 4.05a srt 04/26/13 - Added unalignment checks for Hsize
and Stride (CR 710279) 6.6 rsp 07/02/18 - Program vertical flip state for S2MM
channel </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_channel.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_g.c @addtogroup
axivdma_v6_6 @{ Provide a template for user to define their own hardware
settings. If using XPS, this file will be automatically generated. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 08/16/10
First release 2.00a jz 12/10/10 Added support for direct register access mode,
v3 core 2.01a jz 01/19/11 Added ability to re-assign BD addresses rkv 04/07/11
added new configuration parameter for enabling read of video parameters. 3.00a
srt 08/26/11 Added new parameters for Flush on Frame Sync and Line Buffer
Thresholds. 4.00a srt 11/21/11 Added new parameters for Genlock Source and Fsync
Source Selection. 4.03a srt 01/18/13 Added TDATA_WIDTH parameters (CR: 691866)
4.04a srt 03/03/13 Support for _ENABLE_DEBUG_INFO_ debug configuration
parameters (CR: 703738) 5.1 sha 07/15/15 Added XPAR_XAXIVDMA_NUM_INSTANCES macro
to control config table parameters. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_hw.h @addtogroup
axivdma_v6_6 @{ Hardware definition file. It defines the register interface and
Buffer Descriptor (BD) definitions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a jz 07/30/10 First release 2.00a jz 12/10/10
Added support for direct register access mode, v3 core 2.01a jz 01/19/11 Added
ability to re-assign BD addresses rkv 03/28/11 Added support for frame store
register. 3.00a srt 08/26/11 - Added support for Line Buffer Threshold
Registers. - XAXIVDMA_MISMATCH_ERROR flag is added to support Flush on Frame
Sync for Mismatch Errors. 4.00a srt 11/21/11 - XAxiVdma_ChannelSetBufferAddr API
is changed to support 32 Frame Stores. - XAxiVdma_ChannelConfig API is changed
to support modified Park Offset Register bits. - Added APIs:
XAxiVdma_FsyncSrcSelect() XAxiVdma_GenLockSourceSelect()
XAxiVdma_ChannelHiFrmAddrEnable() XAxiVdma_ChannelHiFrmAddrDisable() 4.01a srt
06/13/12 - Added new error bit mask XAXIVDMA_SR_ERR_SOF_LATE_MASK -
XAXIVDMA_MISMATCH_ERROR flag is deprecated. 4.02a srt 10/11/12 - Changed Error
bitmasks to support IP version 5.02a. (CR 679959) 4.04a srt 03/03/13 - Support
for the GenlockRepeat Control bit (Bit 15) added in the new version of IP v5.04
(CR: 691391) 4.06a srt 04/09/13 - Added support for the newly added
S2MM_DMA_IRQ_MASK register (CR 734741) 6.6 rsp 07/02/18 - Add offset and mask
for Vertical flip register </pre> /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_i.h @addtogroup
axivdma_v6_6 @{ Internal API definitions shared by driver files. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 08/18/10
First release 2.00a jz 12/10/10 Added support for direct register access mode,
v3 core 2.01a jz 01/19/11 Added ability to re-assign BD addresses Replaced
include xenv.h with string.h in xaxivdma_i.h file. rkv 03/28/11 Added support
for frame store register. 3.00a srt 08/26/11 Added support for Flush on Frame
Sync and dynamic programming of Line Buffer Thresholds. 4.00a srt 11/21/11 Added
support for 32 Frame Stores and modified bit mask of Park Offset Register. Added
support for GenLock & Fsync Source Selection. 4.03a srt 01/18/13 - Added
StreamWidth parameter to XAxiVdma_Channel structure (CR 691866). 4.04a srt
03/03/13 Support for the GenlockRepeat Control bit (Bit 15) added in the new
version of IP v5.04 (CR: 691391) Support for _ENABLE_DEBUG_INFO_ debug
configuration parameters (CR: 703738) 6.6 rsp 07/02/18 Add vertical flip states
in config structures </pre> /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_intr.c @addtogroup
axivdma_v6_6 @{ Implementation of interrupt related functions. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 08/16/10
First release 2.00a jz 12/10/10 Added support for direct register access mode,
v3 core 2.01a jz 01/19/11 Added ability to re-assign BD addresses 4.01a srt
06/13/12 Modified the logic of Error handling in interrupt handlers. 4.06a srt
04/09/13 Added API XAxiVdma_MaskS2MMErrIntr which will mask the S2MM interrupt
for the error mask provided. (CR 734741) 6.3 ms 02/20/17 Fixed compilation
error. CR-969129. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_porting_guide.h
@addtogroup axivdma_v6_6 @{ This is a guide on how to move from using the xvdma
driver to use xaxivdma driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jz 08/16/10 First release 2.00a jz 12/10/10 Added
support for direct register access mode, v3 core 2.01a jz 01/19/11 Added ability
to re-assign BD addresses rkv 03/28/11 Added support for frame store register.
3.00a srt 08/26/11 - Added support for Flush on Frame Sync and dynamic
programming of Line Buffer Thresholds. - XAxiVdma_ChannelErrors API is changed
to support for Flush on Frame Sync feature. - Two flags, XST_VDMA_MISMATCH_ERROR
& XAXIVDMA_MIS MATCH_ERROR are added to report error status when Flush on Frame
Sync feature is enabled. 4.00a srt 11/21/11 - XAxiVdma_ChannelSetBufferAddr API
is changed to support 32 Frame Stores. - XAxiVdma_ChannelConfig API is changed
to support modified Park Offset Register bits. - Added APIs:
XAxiVdma_FsyncSrcSelect() XAxiVdma_GenLockSourceSelect() - Modified structures
XAxiVdma_Config and XAxiVdma to include new parameters. 4.01a srt 06/13/12 -
Added APIs: XAxiVdma_GetDmaChannelErrors() XAxiVdma_ClearDmaChannelErrors()
XAxiVdma_ClearChannelErrors() - XAxiVdma_ChannelErrors API is changed to remove
Mismatch error logic. - Removed Error checking logic in the channel APIs.
Provided User APIs to do this. - Added new error bit mask
XAXIVDMA_SR_ERR_SOF_LATE_MASK - XAXIVDMA_MISMATCH_ERROR flag is deprecated. -
Modified the logic of Error handling in interrupt handlers. </pre>
<b>Overview</b> The API for xaxivdma driver is similar to xvdma driver. However,
the prefix for functions and structures is now XAxiVdma_. Due to hardware
changes, for AXI_VDMA core in 12.3, we have changed some API functions, removed
some API functions and added some new API functions. From 13.1 release, the
hardware, v3.00a core supports direct register access mode where transfer is set
through direct register writes. Scatter gather is no longer there if the direct
register access mode is selected. This change does not impact the driver API.
For 13.2 release, the driver supports re-assigning BD addresses. This comes from
the user that it is desirable to change the BD addresses to a memory region that
SG hardware can access. For 13.4 release, the hardware, v5.00a core has added
new features to select Internal GenLock and Frame Sync Sources in the control
register. Due to hardware changes, we have added new API functions for the two
new features. For 14.2 release, the hardware, v5.02a core has modified the
handling of VDMA errors. To support this, we have changed some APIs and added
some new APIs. <b>API That Only Have Prefix Changes</b> Note that API includes
data structures and functions. For API functions that use VDMA data structures
or their pointers as arguments, the structures need to use the new perfix as
well. The following are the data structures that have prefix changed: xvdma API
structures | xaxivdma API structures ------------------------------------| XVDma
| XAxiVdma XVDma_Config | XAxiVdma_Config XVDma_DmaSetup | XAxiVdma_DmaSetup
XVDmaFrameCounter | XAxiVdma_FrameCounter The following is the list of API
functions that only have the prefix changes: xvdma API functions | xaxivdma API
functions ------------------------------------| XVDma_CfgInitialize |
XAxiVdma_CfgInitialize XVDma_StartWriteFrame | XAxiVdma_StartWriteFrame
XVDma_StartReadFrame | XAxiVdma_StartReadFrame XVDma_SetFrameCounter |
XAxiVdma_SetFrameCounter XVDma_GetFrameCounter | XAxiVdma_GetFrameCounter
XVDma_LookupConfig | XAxiVdma_LookupConfig <b>API Functions That Have Been
Changed</b> PLB VDMA only has one channel, while the AXI VDMA has two channels.
This change has caused some of the API functions to take an extra argument to
differentiate the channels. The following functions now take an extra argument
(u16 Direction), the new argument is the last in the argument list: xvdma API
functions | xaxivdma API functions ------------------------------------|
XVDma_Reset | XAxiVdma_Reset XVDma_IsBusy | XAxiVdma_IsBusy XVDma_CurrFrameStore
| XAxiVdma_CurrFrameStore XVDma_IntrEnable | XAxiVdma_IntrEnable
XVDma_IntrDisable | XAxiVdma_IntrDisable XVDma_IntrGetPending |
XAxiVdma_IntrGetPending XVDma_IntrClear | XAxiVdma_IntrClear XVDma_SetCallBack |
XAxiVdma_SetCallBack Note that the xvdma API functions that already have
Direction as the argument are kept as they are, which are not necessarily having
Direction as the last argument. Some API functions have changed return type from
void to int. This is to make the driver more intelligent and signal the failure
early on to the user. The following functions have change return type from void
to int: xvdma API functions | xaxivdma API functions
------------------------------------| void XVDma_DmaConfig | int
XAxiVdma_DmaConfig void XVDma_DmaSetBufferAddr | int XAxiVdma_DmaSetBufferAddr
void XVDma_DmaStart | int XAxiVdma_DmaStart <b>New API Functions</b> New core
v5.02a has added new features, to support them these APIs are added int
XAxiVdma_GetDmaChannelErrors(XAxiVdma InstancePtr, u16 Direction) int
XAxiVdma_ClearDmaChannelErrors(XAxiVdma InstancePtr, u16 Direction, u32
ErrorMask) void XAxiVdma_ClearChannelErrors(XAxiVdma_Channel Channel, u32
ErrorMask) New core v5.00a has added new features, to support them these APIs
are added int XAxiVdma_FsyncSrcSelect(XAxiVdma InstancePtr, u32 Source, u16
Direction) int XAxiVdma_GenLockSourceSelect(XAxiVdma InstancePtr, u32 Source,
u16 Direction) Due to addition of frame store register in hardware these
functions are added int XAxiVdma_SetFrmStore(XAxiVdma InstancePtr, u8
FrmStoreNum, u16 Direction) void XAxiVdma_GetFrmStore(XAxiVdma InstancePtr, u8
FrmStoreNum, u16 Direction) Due to the fact that AXI VDMA has two channels, and
each channel has its own interrupt ID, we removed the single interrupt handler
API from xvdma driver, and added two interrupt handlers: . void
XAxiVdma_ReadIntrHandler(void Ref) . void XAxiVdma_WriteIntrHandler(void Ref)
Based on customers feedback on xvdma, we added XAxiVdma_Stop to stop one
channel: . void XAxiVdma_Stop(XAxiVdma InstancePtr, u16 Direction) We need a
function to check whether reset is done: . int XAxiVdma_ResetNotDone(XAxiVdma
InstancePtr, u16 Direction) While doing the development, it shows the need for
getting the hardware status to provide as much information as possible for
user's development. . u32 XAxiVdma_GetStatus(XAxiVdma InstancePtr, u16
Direction) Because the hardware limitations, parking mode cannot be the initial
mode to start the DMA engine. Entering and exiting parking mode have to be done
after the hardware is running. Therefore, we add two API functions to enter and
exit park mode. . void XAxiVdma_StartParking(XAxiVdma InstancePtr, int
FrameIndex, u16 Direction); . void XAxiVdma_StopParking(XAxiVdma InstancePtr,
u16 Direction); Note that configuring the hardware to be in park mode using
XAxiVdma_DmaConfig() is fine. The advantage of using _StartParking() and
_StopParking() is the simplicity. . void XAxiVdma_StartFrmCntEnable(XAxiVdma
InstancePtr, u16 Direction); This function is used to enable frame count enable.
It is much simpler to enable frame count enable this way than using the full
configuration structure. . int XAxiVdma_SetBdAddrs(XAxiVdma InstancePtr, u32
BdAddrPhys, u32 BdAddrVirt, int NumBds, u16 Direction); This function provides
the ability for the user application to re-assign the BD addresses to wherever
in the memory it wants. This is to aid the situation that SG engine may have
limited access to certain region of the memory, comparing to the processor's
ability. The default BD addresses are inside the region that the processor can
access. <b>API Functions That Have Been Removed</b> Due to hardware design
change, some of the API functions are no longer needed: .
XVDma_CmdInerfaceDisable() . XVDma_CmdInerfaceEnable() .
XVDma_FullDuplexDisable() . XVDma_FullDuplexEnable() . XVDma_HoriCropDisable() .
XVDma_HoriCropEnable() . XVDma_IntrEnableGlobal() . XVDma_IntrDisableGlobal() .
XVDma_IntrHandler() @} /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_porting_guide.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_selftest.c @addtogroup
axivdma_v6_6 @{ Contains diagnostic/self-test functions for the XAxiVdma
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
5.1 adk 29/01/15 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xaxivdma_sinit.c @addtogroup
axivdma_v6_6 @{ Look up the hardware settings using device ID. The hardware
setting is inside the configuration table in xaxivdma_g.c, generated
automatically by XPS or manually by user. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a jz 08/16/10 First release 2.00a jz
12/10/10 Added support for direct register access mode, v3 core 2.01a jz
01/19/11 Added ability to re-assign BD addresses 5.1 sha 07/15/15 Defined macro
XPAR_XAXIVDMA_NUM_INSTANCES if not defined in xparameters.h 6.4 ms 08/07/17
Fixed compilation warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/axivdma/src/xaxivdma_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Ver Who Date Changes -------- ------
-------- 4.0 adk 10/12/13 Updated as per the New Tcl API's 4.1 sk 11/09/15
Removed delete filename statement CR 784758. 4.2 ms 04/18/17 Modified tcl file
to add suffix U for all macros definitions of bram in xparameters.h
@BEGIN_CHANGELOG EDK_P - Added the generation of C_E_FAILING_DATA_REGISTERS to
the config structure to distinguish between AXI BRAM and LMB BRAM. These
registers are not present in the current common::version of the AXI BRAM
Controller. - Added sorting of address parameters to not depend on the order in
the hardware description. @END_CHANGELOG uses "xillib_sw.tcl"

FILES:
XilinxProcessorIPLib/drivers/bram/data/bram.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 10/12/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_I - Add a new argument to gen_include_files.
@END_CHANGELOG @BEGIN_CHANGELOG EDK_H - Added support for generation of multiple
applications. All TCL procedures are now required to have a software project
type as its first argument @END_CHANGELOG @BEGIN_CHANGELOG EDK_M - Migrated to
HAL phase 1 using new xil_testmem API. - Added ECC support @END_CHANGELOG
@BEGIN_CHANGELOG EDK_P - Updated the logic which checks whether interrupt is
connected @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest Global variables Each global string defined here is a C test function
definition. Each function defined here must have a unique function prototype.
Ie. ALL functions defined in this file must be capable of co-existing in the
same C file! TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/bram/data/bram_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram_example.c This file
contains a self test example using the BRAM driver (XBram). <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 05/11/10 Initial
release. 3.01a sa 13/01/12 Changed XBram_SelfTest(InstancePtr) to
XBram_SelfTest(InstancePtr,0) as per new API (CR 639274) 4.1 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/bram/examples/xbram_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram_intr_example.c This file
contains a design example using the BRAM driver (XBram) in an interrupt driven
mode of operation. This example assumes that there is an interrupt controller in
the hardware system and the BRAM device is connected to the interrupt
controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sa 05/11/10 Initial release. 3.01a sa 13/01/12 Changed
XBram_SelfTest(InstancePtr) to XBram_SelfTest(InstancePtr, XBRAM_IR_ALL_MASK) as
per new API (CR 639274) 4.1 ms 01/23/17 Modified xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/bram/examples/xbram_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram.c @addtogroup bram_v4_2
@{ The implementation of the XBram driver's basic functionality. See xbram.h for
more information about the driver. @note None <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a sa 05/11/10 First release 3.01a sa
13/01/12 Added CorrectableFailingDataRegs and UncorrectableFailingDataRegs in
XBram_CfgInitialize API. 4.1 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototype of XBram_CfgInitialize API. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/bram/src/xbram.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram.h @addtogroup bram_v4_2
@{ @details If ECC is not enabled, this driver exists only to allow the tools to
create a memory test application and to populate xparameters.h with memory range
constants. In this case there is no source code. If ECC is enabled, this file
contains the software API definition of the Xilinx BRAM Interface Controller
(XBram) device driver. The Xilinx BRAM controller is a soft IP core designed for
Xilinx FPGAs and contains the following general features: - LMB v2.0 bus
interfaces with byte enable support - Used in conjunction with bram_block
peripheral to provide fast BRAM memory solution for MicroBlaze ILMB and DLMB
ports - Supports byte, half-word, and word transfers - Supports optional BRAM
error correction and detection. The driver provides interrupt management
functions. Implementation of interrupt handlers is left to the user. Refer to
the provided interrupt example in the examples directory for details. This
driver is intended to be RTOS and processor independent. Any needs for dynamic
memory management, threads or thread mutual exclusion, virtual memory, or cache
control must be satisfied by the layer above this driver. <b>Initialization &
Configuration</b> The XBram_Config structure is used by the driver to configure
itself. This configuration structure is typically created by the tool-chain
based on HW build properties. To support multiple runtime loading and
initialization strategies employed by various operating systems, the driver
instance can be initialized as follows: - XBram_CfgInitialize(InstancePtr,
CfgPtr, EffectiveAddr) Uses a configuration structure provided by the caller. If
running in a system with address translation, the provided virtual memory base
address replaces the physical address present in the configuration structure.
@note This API utilizes 32 bit I/O to the BRAM registers. With less than 32
bits, the unused bits from registers are read as zero and written as don't
cares. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
3.00a sa 05/11/10 Added ECC support 3.01a sa 01/13/12 Changed Selftest API from
XBram_SelfTest(XBram InstancePtr) to XBram_SelfTest(XBram InstancePtr, u8
IntMask) and fixed a problem with interrupt generation for CR 639274 Modified
Selftest example to return XST_SUCCESS when ECC is not enabled and return
XST_FAILURE when ECC is enabled and Control Base Address is zero (CR 636581)
Modified Selftest to use correct CorrectableCounterBits for CR 635655 Updated to
check CorrectableFailingDataRegs in the case of LMB BRAM. Added
CorrectableFailingDataRegs and UncorrectableFailingDataRegs to the config
structure to distinguish between AXI BRAM and LMB BRAM. These registers are not
present in the current version of the AXI BRAM Controller. 3.02a sa 04/16/12
Added test of byte and halfword read-modify-write 3.02a sa 04/16/12 Modified
driver tcl to sort the address parameters to support both xps and vivado
designs. 3.02a adk 24/4/13 Modified the tcl file to avoid warnings when ecc is
disabled cr:705002. 3.03a bss 05/22/13 Added Xil_DCacheFlushRange in
xbram_selftest.c to flush the Cache after writing to BRAM in InjectErrors API(CR
719011) 4.0 adk 19/12/13 Updated as per the New Tcl API's 4.1 sk 11/10/15 Used
UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototype of
XBram_CfgInitialize API. ms 01/23/17 Modified xil_printf statement in main
function for all examples to ensure that "Successfully ran" and "Failed" strings
are available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. 4.2 ms 04/18/17
Modified tcl file to add suffix U for all macro definitions of bram in
xparameters.h ms 08/07/17 Fixed compilation warnings in xbram_sinit.c </pre>

FILES:
XilinxProcessorIPLib/drivers/bram/src/xbram.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram_g.c @addtogroup bram_v4_2
@{ This file contains a configuration table that specifies the configuration of
BRAM devices in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a sa 11/05/10 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/bram/src/xbram_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram_hw.h @addtogroup
bram_v4_2 @{ This header file contains identifiers and driver functions (or
macros) that can be used to access the device. The user should refer to the
hardware device specification for more details of the device operation. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 24/11/10
First release </pre>

FILES:
XilinxProcessorIPLib/drivers/bram/src/xbram_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram_intr.c @addtogroup
bram_v4_2 @{ Implements BRAM interrupt processing functions for the XBram
driver. See xbram.h for more information about the driver. The functions in this
file require the hardware device to be built with interrupt capabilities. The
functions will assert if called using hardware that does not have interrupt
capabilities. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sa 05/11/10 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/bram/src/xbram_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram_selftest.c @addtogroup
bram_v4_2 @{ The implementation of the XBram driver's self test function. This
SelfTest is only applicable if ECC is enabled. If ECC is not enabled then this
function will return XST_SUCCESS. See xbram.h for more information about the
driver. Temp change @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a sa 11/24/10 First release 3.01a sa 01/13/12 Changed
Selftest API from XBram_SelfTest(XBram InstancePtr) to XBram_SelfTest(XBram
InstancePtr, u8 IntMask) and fixed a problem with interrupt generation for CR
639274 Modified Selftest example to return XST_SUCCESS when ECC is not enabled
and return XST_FAILURE when ECC is enabled and Control Base Address is zero (CR
636581) Modified Selftest to use correct CorrectableCounterBits for CR 635655
Updated to check CorrectableFailingDataRegs in the case of LMB BRAM. 3.02a sa
04/16/12 Added test of byte and halfword read-modify-write 3.03a bss 05/22/13
Added Xil_DCacheFlushRange in InjectErrors API to flush the Cache after writing
to BRAM (CR 719011) 4.3 aru 04/09/19 Used UINTPTR instead of u32 for Addr in
XBram_SelfTest() </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/bram/src/xbram_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbram_sinit.c @addtogroup
bram_v4_2 @{ The implementation of the XBram driver's static initialization
functionality. @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 2.01a jvb 10/13/05 First release 2.11a mta 03/21/07 Updated to new
coding style 4.2 ms 08/07/17 Fixed compilation warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/bram/src/xbram_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Removed support for xps can
@BEGIN_CHANGELOG EDK_M 11/25/09 ktn removed support for opb_can @END_CHANGELOG
@BEGIN_CHANGELOG EDK_MS3 07/25/10 sdm added support for axi_can 12/19/12 added
support for can @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/can/data/can.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/can/data/can.tcl
XilinxProcessorIPLib/drivers/deinterlacer/data/deinterlacer.tcl
XilinxProcessorIPLib/drivers/osd/data/osd.tcl
XilinxProcessorIPLib/drivers/rfdc/data/rfdc.tcl
XilinxProcessorIPLib/drivers/vtc/data/vtc.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_H - Added support for generation of multiple
applications. All TCL procedures are now required to have a software project
type as its first argument @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS4 08/31/10
Fixed a bug in the tcl because of which Test App was not getting generated
properly - CR 572961 @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl
Software Project Types (swproj): 0 : MemoryTest - Calls basic memorytest
routines from common driver dir 1 : PeripheralTest - Calls any existing
polled_example and/or selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/can/data/can_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan_intr_example.c Contains an
example of how to use the XCan driver directly. The example here shows using the
driver/device in interrupt mode. @note This code assumes that Xilinx interrupt
controller (XIntc) is used in the system to forward the CAN device interrupt
output to the processor and no operating system is being used. The Baud Rate
Prescaler Register (BRPR) and Bit Timing Register (BTR) are setup such that CAN
baud rate equals 40Kbps, assuming that the the CAN clock is 24MHz. The user
needs to modify these values based on the desired baud rate and the CAN clock
frequency. For more information see the CAN 2.0A, CAN 2.0B, ISO 11898-1
specifications. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.00a xd/sv 01/12/09 First release 2.00a ktn 10/22/09 Updated to use
the HAL APIs/macros. The macros have been renamed to remove _m from the name.
2.00a bss 01/11/11 Updated the example to be used with the SCUGIC in Zynq. 2.00a
bss 01/16/12 Updated the example to fix CR 694533, replaced INTC_DEVID with
INTC_DEVICE_ID. 3.2 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. 3.3 ask 08/01/18 Fixed Cppcheck and GCC
warnings in can driver </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/can/examples/xcan_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan_polled_example.c Contains
an example of how to use the XCan driver directly. The example here shows using
the driver/device in polled mode. @note The Baud Rate Prescaler Register (BRPR)
and Bit Timing Register (BTR) are setup such that CAN baud rate equals 40Kbps,
assuming that the the CAN clock frequency is 24MHz. The user needs to modify
these values based on the desired baud rate and the CAN clock frequency. For
more information see the CAN 2.0A, CAN 2.0B, ISO 11898-1 specifications. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd
04/12/05 First release 2.00a ktn 10/22/09 Updated driver to use the HAL
APIs/macros. The macros have been renamed to remove _m from the name. 3.2 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. 3.3 ask 08/01/18 Fixed Cppcheck and GCC warnings in can
driver </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/can/examples/xcan_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan.c @addtogroup can_v3_3 @{
The XCan driver. Functions in this file are the minimum required functions for
this driver. See xcan.h for a detailed description of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a xd 04/12/05
First release 1.10a mta 05/13/07 Updated to new coding style 2.00a ktn 10/22/09
Updated to use the HAL APIs/macros. The macros have been renamed to remove _m
from the name in all the driver files. 3.2 sk 11/10/15 Used UINTPTR instead of
u32 for Baseaddress CR 867425. Changed the prototype of XCan_VmInitialize API.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/can/src/xcan.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan.h @addtogroup can_v3_3 @{
@details The Xilinx CAN driver. This driver supports the Xilinx CAN Controller.
The CAN Controller supports the following features: - Confirms to the ISO
11898-1, CAN 2.0A and CAN 2.0B standards. - Supports both Standard (11 bit
Identifier) and Extended (29 bit Identifier) frames. - Supports Bit Rates up to
1 Mbps. - Transmit message object FIFO with a user configurable depth of up to
64 message objects. - Transmit prioritization through one TX High Priority
Buffer. - Receive message object FIFO with a user configurable depth of up to 64
message objects. - Acceptance filtering through a user configurable number of up
to 4 acceptance filters. - Loop Back mode for diagnostic applications. -
Maskable Error and Status Interrupts. - Readable Error Counters. - External PHY
chip required. The device driver supports all the features listed above, if
applicable. <b>Driver Description</b> The device driver enables higher layer
software (e.g., an application) to communicate to the CAN. The driver handles
transmission and reception of CAN frames, as well as configuration of the
controller. The driver is simply a pass-through mechanism between a protocol
stack and the CAN. A single device driver can support multiple CANs. Since the
driver is a simple pass-through mechanism between a protocol stack and the CAN,
no assembly or disassembly of CAN frames is done at the driver-level. This
assumes that the protocol stack passes a correctly formatted CAN frame to the
driver for transmission, and that the driver does not validate the contents of
an incoming frame <b>Operation Modes</b> The CAN controller supports the
following modes of operation: - <b>Configuration Mode</b>: In this mode the CAN
timing parameters and Baud Rate Pre-scalar parameters can be changed. In this
mode the CAN controller loses synchronization with the CAN bus and drives a
constant recessive bit on the bus line. The Error Counter Register are reset.
The CAN controller does not receive or transmit any messages even if there are
pending transmit requests from the TX FIFO or the TX High Priority Buffer. the
Storage FIFOs and the CAN configuration registers are still accessible. -
<b>Normal Mode</b>:In Normal Mode the CAN controller participates in bus
communication, by transmitting and receiving messages. - <b>Sleep Mode</b>: In
Sleep Mode the CAN Controller does not transmit any messages. However, if any
other node transmits a message, then the CAN Controller receives the transmitted
message and exits from Sleep Mode. If there are new transmission requests from
either the TX FIFO or the TX High Priority Buffer when the CAN Controller is in
Sleep Mode, these requests are not serviced, and the CAN Controller continues to
remain in Sleep Mode. Interrupts are generated when the CAN controller enters
Sleep mode or Wakes up from Sleep mode. - <b>Loop Back Mode</b>: In Loop Back
mode, the CAN controller transmits a recessive bit stream on to the CAN Bus. Any
message that is transmitted is loop backed to the rx line and acknowledged.
The CAN controller thus receives any message that it transmits. It does not
participate in normal bus communication and does not receive any messages that
are transmitted by other CAN nodes. This mode is used for diagnostic purposes.
<b>Buffer Alignment</b> It is important to note that frame buffers passed to the
driver must be 32-bit aligned. <b>Receive Address Filtering</b> The device can
be set to accept frames whose Identifiers match any of up to 4 filters set in
the Acceptance Filter Mask/ID registers. The incoming Identifier is masked with
the bits in the Acceptance Filter Mask Register. This value is compared with the
result of masking the bits in the Acceptance Filter ID Register with the
Acceptance Filter Mask Register. If both these values are equal, the message
will be stored in the RX FIFO. Acceptance Filtering is performed by each of the
defined acceptance filters. If the incoming identifier passes through any
acceptance filter then the frame is stored in the RX FIFO. <b>PHY
Communication</b> This driver does not provide any mechanism for directly
programming PHY. <b>Interrupts</b> The driver has no dependencies on the
interrupt controller. The driver provides an interrupt handler. User of this
driver needs to provide callback functions. An interrupt handler example is
available with the driver. <b>Virtual Memory</b> This driver supports Virtual
Memory. The RTOS is responsible for calculating the correct device base address
in Virtual Memory space and invoking function XCan_VmInitialize(), instead of
XCan_Initialize(), to initialize the device at first. <b>Threads</b> This driver
is not thread safe. Any needs for threads or thread mutual exclusion must be
satisfied by the layer above this driver. <b>Device Reset</b> Bus Off interrupt
that can occur in the device requires a device reset. The user is responsible
for resetting the device and re-configuring it based on its needs (the driver
does not save the current configuration). When integrating into an RTOS, these
reset and re-configure obligations are taken care of by the OS adapter software
if it exists for that RTOS. <b>Device Configuration</b> The device can be
configured in various ways during the FPGA implementation process. Configuration
parameters are stored in the xcan_g.c files. A table is defined where each entry
contains configuration information for a CAN device. This information includes
such things as the base address of the memory-mapped device, and the number of
acceptance filters. <b>Asserts</b> Asserts are used within all Xilinx drivers to
enforce constraints on argument values. Asserts can be turned off on a system-
wide basis by defining, at compile time, the NDEBUG identifier. By default,
asserts are turned on and it is recommended that users leave asserts on during
development. <b>Building the driver</b> The XCan driver is composed of several
source files. This allows the user to build and link only those parts of the
driver that are necessary. <br><br> <pre> Temp Change MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a xd 04/12/05 First release 1.10a mta
05/13/07 Updated to new coding style 1.11a sdm 08/22/08 Removed support for
static interrupt handlers from the MDD file 2.00a ktn 10/22/09 Updated driver to
use the HAL APIs/macros. The macros have been renamed to remove _m from the name
in all the driver files. 3.0 adk 19/12/13 Updated as per the New Tcl API's 3.1
adk 20/10/15 Update the driver tcl to check for valid IP parameters. CR910450.
3.2 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed
the prototype of XCan_VmInitialize API. ms 01/23/17 Added xil_printf statement
in main function for all examples to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. 3.3 ask
08/01/18 Fixed Cppcheck and GCC warnings in can driver </pre>

FILES:
XilinxProcessorIPLib/drivers/can/src/xcan.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan_config.c @addtogroup
can_v3_3 @{ Functions in this file are CAN Configuration Register access
related. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a xd 04/12/05 First release 1.10a mta 05/13/07 Updated to new coding style
2.00a ktn 10/22/09 Updated to use the HAL APIs/macros. The macros have been
renamed to remove _m from the name. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/can/src/xcan_config.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan_g.c @addtogroup can_v3_3
@{ This file contains a configuration table that specifies the configuration of
CAN devices in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a xd 04/12/05 First release 1.10a mta 05/13/07 Updated
to new coding style </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/can/src/xcan_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan_intr.c @addtogroup
can_v3_3 @{ This file contains functions related to CAN interrupt handling.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a xd
04/12/05 First release 1.10a mta 05/13/07 Updated to new coding style 2.00a ktn
10/22/09 Updated to use the HAL APIs/macros. The macros have been renamed to
remove _m from the name. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/can/src/xcan_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan_l.h @addtogroup can_v3_3
@{ This header file contains the identifiers and basic driver functions (or
macros) that can be used to access the device. Other driver functions are
defined in xcan.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a xd 04/12/05 First release 1.10a mta 05/13/07 Updated to new
coding style 2.00a ktn 10/22/09 Updated to use the HAL APIs/macros. The macros
have been renamed to remove _m from the name. </pre>

FILES:
XilinxProcessorIPLib/drivers/can/src/xcan_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcan_selftest.c @addtogroup
can_v3_3 @{ This file contains a diagnostic self-test function for the XCan
driver. Please see xcan.h for more information. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a xd 04/12/05 First release 1.10a mta
05/13/07 Updated to new coding style 2.00a ktn 10/22/09 Updated to use the HAL
APIs/macros. The macros have been renamed to remove _m from the name. 3.3 ask
08/01/18 Fixed Cppcheck and GCC warnings in can driver </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/can/src/xcan_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 nsk 06/04/15 First version of CANFD
@BEGIN_CHANGELOG EDK_M @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3 @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/canfd/data/canfd.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ---- ----- ------- 1.0 nsk 15/05/15 Updated as per RTL. TxBuffer Can be
configurable(8,16,32). 2.1 ask 07/03/18 Added a macro to distinguish between
CANFD_v1_0 and CANFD_v2_0. 2.1 nsk 07/11/18 Added CANFD Frequency macro to
xparameters.h 2.1 nsk 09/03/18 Added support for all CANFD versions i.e. PS
CANFD, PL CANFD 1.0 and PL CANFD 2.0 uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/canfd/data/canfd.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanfd_intr_example.c Contains
an example of how to use the XCan driver directly. The example here shows using
the driver/device in interrupt mode. @note This code assumes that Xilinx
interrupt controller (XIntc) is used in the system to forward the CAN device
interrupt output to the processor and no operating system is being used. The
Baud Rate Prescaler Register (BRPR) and Bit Timing Register (BTR) are setup such
that CAN baud rate equals 40Kbps, assuming that the the CAN clock is 24MHz. The
user needs to modify these values based on the desired baud rate and the CAN
clock frequency. For more information see the CAN 2.0A, CAN 2.0B, ISO 11898-1
specifications. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 nsk 06/04/15 First release 1.2 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Added tabspace for return statements in functions for proper documentation while
generating doxygen. 2.1 ask 07/03/18 Added timeout, and Code to handle Timestamp
Counter Overflow Interrupt for CR 992606, CR 1004222 and fixed gcc warnings. ask
08/08/18 Changed the Can ID to 11 bit value as standard Can ID is 11 bit. ask
09/12/18 Added timeout, and Code to handle Timestamp Counter Overflow Interrupt.
Made logic generic for both scugic and intc vectors. 2.1 nsk 03/09/19 Fix build
error in example </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canfd/examples/xcanfd_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file XCanFd_polled_example.c
Contains an example of how to use the XCan driver directly. The example here
shows using the driver/device in polled mode. @note The Baud Rate Prescaler
Register (BRPR) and Bit Timing Register (BTR) are setup such that CAN baud rate
equals 40Kbps, assuming that the the CAN clock frequency is 24MHz. The user
needs to modify these values based on the desired baud rate and the CAN clock
frequency. For more information see the CAN 2.0A, CAN 2.0B, ISO 11898-1
specifications. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 nsk 06/04/15 First release 1.2 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Added tabspace for return statements in functions for proper documentation while
generating doxygen. 1.3 ask 08/08/18 Changed the Can ID to 11 bit value as
standard Can ID is 11 bit. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canfd/examples/xcanfd_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanfd.c @addtogroup canfd_v2_2
@{ The XCanFd driver. Functions in this file are the minimum required functions
for this driver. See xcanfd.h for a detailed description of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 nsk 06/04/15
First release 1.0 nsk 15/05/15 Updated Correct AFRID and AFRMSK Registers.
Modified DataSwaping when EDL is Zero. (CR 861772) 1.0 nsk 16/06/15 Updated
XCanFd_Recv_Mailbox(), XCanFd_EnterMode(), XCanFd_GetMode() since RTL has
changed.RTL Changes,Added new bits to MSR,SR,ISR,IER,ICR Registers and modified
TS2 bits in BTR and F_SJW bits in F_BTR Registers. 1.1 sk 11/10/15 Used UINTPTR
instead of u32 for Baseaddress CR 867425. Changed the prototype of
XCanFd_CfgInitialize API. 1.2 mi 09/22/16 Fixed compilation warnings. 2.1 ask
09/21/18 Added support for canfd 2.0 spec in PL canfd SoftIP. Added
Api:XCanFd_Recv_Sequential XCanFd_SeqRecv_logic XCanFd_Recv_TXEvents_Sequential
XCanFd_GetNofMessages_Stored_TXE_FIFO XCanFd_GetNofMessages_Stored_Rx_Fifo Fixed
Message Queuing logic by modifying in functions XCanFd_Send_Queue,
XCanFd_Addto_Queue, XCanFd_Send, and XCanFd_GetFreeBuffer. Added an static
function XCanfd_TrrVal_Get_SetBit_Position. Added Macros regarding legacy API.
ask 09/27/18 Removed unnecessary register read from XCanFd_Send ask 07/03/18 Fix
for Sequential recv CR 992606,CR 1004222. ask 08/27/18 Modified RecvSeq function
to return XST_NO_DATA when the fifo fill levels are zero. ask 08/08/18 Fixed
Cppcheck warnings. 2.1 nsk 01/22/19 Pass correct fifo number to
XCanFd_SeqRecv_logic() CR 1018379 2.1 nsk 03/09/19 For CAN frames, DLC should
always 8, even data bytes are greater than 8. CR 1022045. 2.1 nsk 03/09/19 Fix
for TrrMask to not to get written when using XCanFd_Addto_Queue(), to send more
than 32 buffers. CR 1022093 2.2 sn 06/11/19 Inactivating Mailbox RX buffers
based on requirement. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canfd/src/xcanfd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanfd.h @addtogroup canfd_v2_2
@{ @details The Xilinx CANFD driver. This driver supports the Xilinx CANFD
Controller. The CANFD Controller supports the following features: - Confirms to
the ISO 11898-1, CAN 2.0A and CAN 2.0B standards. - Supports both Standard (11
bit Identifier) and Extended (29 bit Identifier) frames. - Supports Bit Rates up
to 8 Mbps. - Transmit message object FIFO with a user configurable depth of up
to 64 message objects. - Receive message object FIFO with a user configurable
depth of up to 64 message objects. - Acceptance filtering through a user
configurable number of up to 32 acceptance filters. - Loop Back mode for
diagnostic applications. - Maskable Error and Status Interrupts. - Readable
Error Counters. - External PHY chip required. - Backward compatible for Legacy
CAN. - Supports reception in Mailbox and Sequential Mode The device driver
supports all the features listed above, if applicable. <b>Driver Description</b>
The device driver enables higher layer software (e.g., an application) to
communicate to the CANFD. The driver handles transmission and reception of CAN
frames, as well as configuration of the controller. The driver is simply a pass-
through mechanism between a protocol stack and the CANFD. A single device driver
can support multiple CANFDs. Since the driver is a simple pass-through mechanism
between a protocol stack and the CANFD, no assembly or disassembly of CANFD
frames is done at the driver-level. This assumes that the protocol stack passes
a correctly formatted CANFD frame to the driver for transmission, and that the
driver does not validate the contents of an incoming frame <b>Operation
Modes</b> The CANFD controller supports the following modes of operation: -
<b>Configuration Mode</b>: In this mode the CAN timing parameters and Baud Rate
Pre-scalar parameters can be changed. In this mode the CAN controller loses
synchronization with the CAN bus and drives a constant recessive bit on the bus
line. The Error Counter Register are reset. The CAN controller does not receive
or transmit any messages even if there are pending transmit requests from the TX
FIFO or the TX High Priority Buffer. the Storage FIFOs and the CAN configuration
registers are still accessible. - <b>Normal Mode</b>:In Normal Mode the CAN
controller participates in bus communication, by transmitting and receiving
messages. - <b>Sleep Mode</b>: In Sleep Mode the CAN Controller does not
transmit any messages. However, if any other node transmits a message, then the
CAN Controller receives the transmitted message and exits from Sleep Mode. If
there are new transmission requests from either the TX FIFO or the TX High
Priority Buffer when the CAN Controller is in Sleep Mode, these requests are not
serviced, and the CAN Controller continues to remain in Sleep Mode. Interrupts
are generated when the CAN controller enters Sleep mode or Wakes up from Sleep
mode. - <b>Loop Back Mode</b>: In Loop Back mode, the CAN controller transmits a
recessive bit stream on to the CAN Bus. Any message that is transmitted is loop
backed to the rx line and acknowledged. The CAN controller thus receives any
message that it transmits. It does not participate in normal bus communication
and does not receive any messages that are transmitted by other CAN nodes. This
mode is used for diagnostic purposes. - <b>Snoop mode</b>:in Snoop Mode,The CAN
controller transmits recessive bit stream on to CAN bus and does not participate
in normal bus communication but receives messages that are transmitted by other
CAN nodes.Received messages are stored based on receive ID match result. Error
counters are disabled and cleared to 0. Reads to error counter register will
return zero. <b>Buffer Alignment</b> It is important to note that frame buffers
passed to the driver must be 32-bit aligned. <b>Receive Address Filtering</b>
The device can be set to accept frames whose Identifiers match any of up to 32
filters set in the Acceptance Filter Mask/ID registers. The incoming Identifier
is masked with the bits in the Acceptance Filter Mask Register. This value is
compared with the result of masking the bits in the Acceptance Filter ID
Register with the Acceptance Filter Mask Register. If both these values are
equal, the message will be stored in the RX FIFO. Acceptance Filtering is
performed by each of the defined acceptance filters. If the incoming identifier
passes through any acceptance filter then the frame is stored in the RX FIFO.
<b>PHY Communication</b> This driver does not provide any mechanism for directly
programming PHY. <b>Interrupts</b> The driver has no dependencies on the
interrupt controller. The driver provides an interrupt handler. User of this
driver needs to provide callback functions. An interrupt handler example is
available with the driver. <b>Virtual Memory</b> This driver supports Virtual
Memory. The RTOS is responsible for calculating the correct device base address
in Virtual Memory space and invoking function XCanFd_VmInitialize(), instead of
XCanFd_Initialize(), to initialize the device at first. <b>Threads</b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b>Device Reset</b> Bus Off
interrupt that can occur in the device requires a device reset. The user is
responsible for resetting the device and re-configuring it based on its needs
(the driver does not save the current configuration). When integrating into an
RTOS, these reset and re-configure obligations are taken care of by the OS
adapter software if it exists for that RTOS. <b>Device Configuration</b> The
device can be configured in various ways during the FPGA implementation process.
Configuration parameters are stored in the xcan_g.c files. A table is defined
where each entry contains configuration information for a CAN device. This
information includes such things as the base address of the memory-mapped
device, and the number of acceptance filters. <b>Asserts</b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b>Building the driver</b> The XCanFd
driver is composed of several source files.This allows the user to build and
link only those parts of the driver that are necessary. <br><br> <pre> Temp
Change MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 nsk
06/04/15 First release 1.0 nsk 15/05/15 Updated xcanfd.c for correct AFRID and
AFRMSK Registers Updated xcanfd.c and xcanfd.h to get configurable TxBuffers in
XCanFd_Config Struct and XCanFd_GetFreeBuffer(). Modified XCANFD_BTR_TS1_MASK in
xcanfd_hw.h. Updated xcanfd.c while sending data when EDL is Zero. Updated
driver tcl file to get configurable TxBuffers. (CR 861772). 1.0 nsk 16/06/15
Updated XCanFd_Recv_Mailbox(), XCanFd_EnterMode() XCanFd_GetMode() in xcanfd.c
and Added new definition for Register bits in xcanfd_hw.h and updated
XCanFd_IntrHandler() in xcanfd_intr.c as per new RTL. Changes in RTL, Added new
bits to MSR,SR,ISR,IER,ICR Registers and modified TS2 bits in BTR and F_SJW bits
in F_BTR Registers. 1.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress
CR 867425. Changed the prototype of XCanFd_CfgInitialize API. 1.2 mi 09/22/16
Fixed compilation warnings. ms 01/23/17 Modified xil_printf statement in main
function for all examples to ensure that "Successfully ran" and "Failed" strings
are available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. ms 04/05/17 Added
tabspace for return statements in functions of canfd examples for proper
documentation while generating doxygen. 2.0 mj 1/3/18 updated
supported_peripherals and version number CR 991037. CANFD Driver not pulled by
drivers. 2.1 ask 09/12/18 Added support for canfd 2.0 spec sequential mode.
API's added : XCanFd_Recv_Sequential XCanFd_SeqRecv_logic
XCanFd_Recv_TXEvents_Sequential XCanFd_GetNofMessages_Stored_TXE_FIFO
XCanFd_GetNofMessages_Stored_Rx_Fifo above apis added in xcanfd.c .
XCanFd_SetRxIntrWatermarkFifo1 XCanFd_SetTxEventIntrWatermark
XCanFd_SetRxFilterPartition above apis added in xcanfd_config.c
XCANFD_TXEID_OFFSET XCANFD_TXEDLC_OFFSET XCANFD_FIFO_1_RXID_OFFSET
XCANFD_FIFO_1_RXDLC_OFFSET XCANFD_FIFO_1_RXDW_OFFSET above apis added in
xcanfd.h Fixed Message Queuing logic by modifying in functions
XCanFd_Send_Queue, XCanFd_Addto_Queue, XCanFd_Send, and XCanFd_GetFreeBuffer.
Added an static function XCanfd_TrrVal_Get_SetBit_Position, added in xcanfd.c
XCanFD_Check_TrrVal_Set_Bit, added in xcanfd.h Modified apis XCanFd_SetBitTiming
XCanFd_SetFBitTiming in xcanfd.h ask 07/03/18 Fix for Sequential recv CR
992606,CR 1004222. nsk 07/11/18 Updated tcl to generate CANFD Frequency macro in
xparameters.h (CR 1005641). ask 08/27/18 Modified RecvSeq function to return
XST_NO_DATA when the fifo fill levels are zero. ask 08/08/18 Fixed Gcc, Cppcheck
and doxygen warnings in api's : XCanFd_PollQueue_Buffer, XCanFd_AcceptFilterSet,
XCanFd_Recv_Sequential, XCanFd_SetBitTiming,
XCanFd_SetBitRateSwitch_EnableNominal. Changed value of Canfd Id to 11 bit value
to comply with standard Can ID. ask 09/21/18 Fixed CanFD hang issue in selftest
by correcting the Configuration regarding the Baud Rate and bit timing for both
Arbitration and Data Phase. 2.1 nsk 01/22/19 Pass correct fifo number to
XCanFd_SeqRecv_logic() in xcanfd.c CR 1018379 2.1 nsk 01/22/19 Fixed
XCanFd_SetFBaudPrescalar(), which is not setting prescalar value properly in
xcanfd_config.c CR 1016013 2.1 nsk 03/09/19 Updated XCanFd_GetDlc2len(), for CAN
frames, to handle number of data bytes greater than 8. CR 1022045 2.1 nsk
03/09/19 Fix for TrrMask to not to get written when using XCanFd_Addto_Queue().
CR 1022093 2.1 nsk 03/09/19 Added support for PS CANFD, PL CANFD 1.0 and PL
CANFD 2.0 CR 1021963 2.2 sn 06/11/19 Corrected below incorrect Mask values for
CANFD2.0 in xcanfd_hw.h XCANFD_MAILBOX_RB_MASK_BASE_OFFSET,XCANFD_WMR_RXFP_MASK
and CONTROL_STATUS_3. </pre>

FILES:
XilinxProcessorIPLib/drivers/canfd/src/xcanfd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanfd_config.c @addtogroup
canfd_v2_2 @{ Functions in this file are CAN Configuration Register access
related. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 nsk 06/04/15 First release 2.1 ask 06/25/18 Added support for canfd 2.0 spec
sequential mode CR 992606, CR 1004222. Added Api: XCanFd_SetRxIntrWatermarkFifo1
XCanFd_SetTxEventIntrWatermark XCanFd_SetRxFilterPartition Modified Api:
XCanFd_SetBitTiming XCanFd_SetFBitTiming 2.1 nsk 01/22/19 Fixed
XCanFd_SetFBaudPrescalar(), which is not setting prescalar value properly CR
1016013 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canfd/src/xcanfd_config.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanfd_hw.h @addtogroup
canfd_v2_2 @{ This header file contains the identifiers and basic driver
functions (or macros) that can be used to access the device. Other driver
functions are defined in xcanfd.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- ---------- 1.0 nsk 06/04/2015 First release 1.0 nsk
15/05/2015 Modified XCANFD_BTR_TS1_MASK (CR 861772). 1.0 nsk 16/06/2015 Added
New definitions for Register bits since RTL has changed.RTL Changes,Added new
bits to MSR,SR,ISR,IER,ICR Registers and modified TS2 bits in BTR and F_SJW bits
in F_BTR Registers. 2.1 ask 07/03/18 Added support for canfd 2.0 spec sequential
mode. ask 07/03/18 Fix for Sequential recv CR 992606,CR 1004222. 2.2 sn 06/11/19
Updated Mailbox RX buffer offset for CANFD2.0 Fixed below incorrect mask values
XCANFD_MAILBOX_RB_MASK_BASE_OFFSET,XCANFD_WMR_RXFP_MASK and CONTROL_STATUS_3.
</pre>

FILES:
XilinxProcessorIPLib/drivers/canfd/src/xcanfd_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanfd_intr.c @addtogroup
canfd_v2_2 @{ This file contains functions related to CAN interrupt handling.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------- 1.0 nsk
06/04/15 First release 1.0 nsk 16/06/15 Updated XCanFd_IntrHandler() since RTL
has changed. RTL Changes,Added new bits to MSR,SR,ISR, IER,ICR Registers and
modified TS2 bits in BTR and F_SJW bits in F_BTR Registers. 1.2 mi 09/22/16
Fixed compilation warnings. 2.1 ask 07/03/18 Added support for canfd 2.0 spec
sequential mode. XCanFd_SetRxIntrWatermark : This function has been moved to
xcanfd_intr.c ask 07/03/18 Fix for Sequential recv CR 992606,CR 1004222. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/canfd/src/xcanfd_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanfd_selftest.c @addtogroup
canfd_v2_2 @{ This file contains a diagnostic self-test function for the XCanFd
driver. Please see xcanfd.h for more information. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 nsk 06/04/15 First release 1.2 mi
09/22/16 Fixed compilation warnings. 1.3 ask 08/08/18 Fixed Cppcheck warnings
and updated the Canfd Id with 11 bit value 2.1 ask 09/21/18 Fixed CanFD hang
issue in selftest by correcting the Configuration regarding the Baud Rate and
bit timing for both Arbitration and Data Phase. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canfd/src/xcanfd_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanFd_sinit.c @addtogroup
canfd_v2_2 @{ This file contains the implementation of the XCanFd driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.0 nsk 06/03/15 First release 1.3 ask
08/08/18 Fixed doxygen warnings 2.0 ask 09/12/18 Added support for canfd 2.0
spec sequential mode </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canfd/src/xcanfd_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/22/11 Created uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/canps/data/canps.tcl
XilinxProcessorIPLib/drivers/gpiops/data/gpiops.tcl
XilinxProcessorIPLib/drivers/scutimer/data/scutimer.tcl
XilinxProcessorIPLib/drivers/spips/data/spips.tcl
XilinxProcessorIPLib/drivers/uartps/data/uartps.tcl
XilinxProcessorIPLib/drivers/usbps/data/usbps.tcl
XilinxProcessorIPLib/drivers/wdtps/data/wdtps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes -------- ------ -------- 2.0 adk 10/12/13 Updated as per the New Tcl
API's 3.1 mus 01/14/16 Added support for microblaze Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/canps/data/canps_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_intr_example.c Contains
an example of how to use the XCanPs driver directly. This example shows the
usage of the driver/device in interrupt mode. @note The Baud Rate Prescaler
Register (BRPR) and Bit Timing Register (BTR) are setup such that CAN baud rate
equals 40Kbps, assuming that the the CAN clock is 24MHz. The user needs to
modify these values based on the desired baud rate and the CAN clock frequency.
For more information see the CAN 2.0A, CAN 2.0B, ISO 11898-1 specifications.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a
xd/sv 01/12/10 First release 2.1 adk 23/08/14 Fixed CR:798792 Peripheral test
for CANPS IP in SDK claims a 40kbps baud rate but it's not. 3.1 mus 01/14/16
Added support for intc interrupt controller </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/examples/xcanps_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_polled_example.c
Contains an example of how to use the XCanPs driver directly. This example shows
the using the driver/device in polled mode. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv 01/12/10 First
release 2.1 adk 23/08/14 Fixed CR:798792 Peripheral test for CANPS IP in SDK
claims a 40kbps baud rate but it's not. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/examples/xcanps_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_watermark_intr_example.c
This example shows how to use the CAN driver/device in interrupt mode using the
Rx Watermark Interrupt. @note The Baud Rate Prescaler Register (BRPR) and Bit
Timing Register (BTR) are setup such that CAN baud rate equals 40Kbps, assuming
that the the CAN clock is 24MHz. The user needs to modify these values based on
the desired bau rate and the CAN clock frequency. For more information see the
CAN 2.0A, CAN 2.0B, ISO 11898-1 specifications. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a xd/sv 01/12/10 First release 3.1 adk
10/11/15 Fixed CR911958 Add support for Tx Watermark testing. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/canps/examples/xcanps_watermark_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps.c @addtogroup canps_v3_2
@{ Functions in this file are the minimum required functions for the XCanPs
driver. See xcanps.h for a detailed description of the driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv
01/12/10 First release 1.01a bss 12/27/11 Added the APIs
XCanPs_SetTxIntrWatermark and XCanPs_GetTxIntrWatermark. 3.00 kvn 02/13/15
Modified code for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps.h @addtogroup canps_v3_2
@{ @details The Xilinx CAN driver component. This component supports the Xilinx
CAN Controller. The CAN Controller supports the following features: - Confirms
to the ISO 11898-1, CAN 2.0A and CAN 2.0B standards. - Supports both Standard
(11 bit Identifier) and Extended (29 bit Identifier) frames. - Supports Bit
Rates up to 1 Mbps. - Transmit message object FIFO with a user configurable
depth of up to 64 message objects. - Transmit prioritization through one TX High
Priority Buffer. - Receive message object FIFO with a user configurable depth of
up to 64 message objects. - Watermark interrupts for Rx FIFO with configurable
Watermark. - Acceptance filtering with 4 acceptance filters. - Sleep mode with
automatic wake up. - Loop Back mode for diagnostic applications. - Snoop mode
for diagnostic applications. - Maskable Error and Status Interrupts. - Readable
Error Counters. - External PHY chip required. - Receive Timestamp. The device
driver supports all the features listed above, if applicable. <b>Driver
Description</b> The device driver enables higher layer software (e.g., an
application) to communicate to the CAN. The driver handles transmission and
reception of CAN frames, as well as configuration of the controller. The driver
is simply a pass-through mechanism between a protocol stack and the CAN. A
single device driver can support multiple CANs. Since the driver is a simple
pass-through mechanism between a protocol stack and the CAN, no assembly or
disassembly of CAN frames is done at the driver-level. This assumes that the
protocol stack passes a correctly formatted CAN frame to the driver for
transmission, and that the driver does not validate the contents of an incoming
frame <b>Operation Modes</b> The CAN controller supports the following modes of
operation: - <b>Configuration Mode</b>: In this mode the CAN timing parameters
and Baud Rate Pre-scalar parameters can be changed. In this mode the CAN
controller loses synchronization with the CAN bus and drives a constant
recessive bit on the bus line. The Error Counter Register are reset. The CAN
controller does not receive or transmit any messages even if there are pending
transmit requests from the TX FIFO or the TX High Priority Buffer. The Storage
FIFOs and the CAN configuration registers are still accessible. - <b>Normal
Mode</b>:In Normal Mode the CAN controller participates in bus communication, by
transmitting and receiving messages. - <b>Sleep Mode</b>: In Sleep Mode the CAN
Controller does not transmit any messages. However, if any other node transmits
a message, then the CAN Controller receives the transmitted message and exits
from Sleep Mode. If there are new transmission requests from either the TX FIFO
or the TX High Priority Buffer when the CAN Controller is in Sleep Mode, these
requests are not serviced, and the CAN Controller continues to remain in Sleep
Mode. Interrupts are generated when the CAN controller enters Sleep mode or
Wakes up from Sleep mode. - <b>Loop Back Mode</b>: In Loop Back mode, the CAN
controller transmits a recessive bit stream on to the CAN Bus. Any message that
is transmitted is looped back to the �Rx� line and acknowledged. The CAN
controller thus receives any message that it transmits. It does not participate
in normal bus communication and does not receive any messages that are
transmitted by other CAN nodes. This mode is used for diagnostic purposes. -
<b>Snoop Mode</b>: In Snoop mode, the CAN controller transmits a recessive bit
stream on to the CAN Bus and does not participate in normal bus communication
but receives messages that are transmitted by other CAN nodes. This mode is used
for diagnostic purposes. <b>Buffer Alignment</b> It is important to note that
frame buffers passed to the driver must be 32-bit aligned. <b>Receive Address
Filtering</b> The device can be set to accept frames whose Identifiers match any
of the 4 filters set in the Acceptance Filter Mask/ID registers. The incoming
Identifier is masked with the bits in the Acceptance Filter Mask Register. This
value is compared with the result of masking the bits in the Acceptance Filter
ID Register with the Acceptance Filter Mask Register. If both these values are
equal, the message will be stored in the RX FIFO. Acceptance Filtering is
performed by each of the defined acceptance filters. If the incoming identifier
passes through any acceptance filter then the frame is stored in the RX FIFO. If
the Accpetance Filters are not set up then all the received messages are stroed
in the RX FIFO. <b>PHY Communication</b> This driver does not provide any
mechanism for directly programming PHY. <b>Interrupts</b> The driver has no
dependencies on the interrupt controller. The driver provides an interrupt
handler. User of this driver needs to provide callback functions. An interrupt
handler example is available with the driver. <b>Threads</b> This driver is not
thread safe. Any needs for threads or thread mutual exclusion must be satisfied
by the layer above this driver. <b>Device Reset</b> Bus Off interrupt that can
occur in the device requires a device reset. The user is responsible for
resetting the device and re-configuring it based on its needs (the driver does
not save the current configuration). When integrating into an RTOS, these reset
and re-configure obligations are taken care of by the OS adapter software if it
exists for that RTOS. <b>Device Configuration</b> The device can be configured
in various ways during the FPGA implementation process. Configuration parameters
are stored in the xcanps_g.c files. A table is defined where each entry contains
configuration information for a CAN device. This information includes such
things as the base address of the memory-mapped device. <b>Asserts</b> Asserts
are used within all Xilinx drivers to enforce constraints on argument values.
Asserts can be turned off on a system-wide basis by defining, at compile time,
the NDEBUG identifier. By default, asserts are turned on and it is recommended
that users leave asserts on during development. <b>Building the driver</b> The
XCanPs driver is composed of several source files. This allows the user to build
and link only those parts of the driver that are necessary. <br><br> <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv
01/12/10 First release 1.01a bss 12/27/11 Added the APIs
XCanPs_SetTxIntrWatermark and XCanPs_GetTxIntrWatermark. Updated the
Register/bit definitions Changed XCANPS_RXFWIR_RXFLL_MASK to XCANPS_WIR_FW_MASK
Changed XCANPS_RXWIR_OFFSET to XCANPS_WIR_OFFSET Added XCANPS_IXR_TXFEMP_MASK
for Tx Fifo Empty Changed XCANPS_IXR_RXFLL_MASK to XCANPS_IXR_RXFWMFLL_MASK
Changed XCANPS_TXBUF_ID_OFFSET to XCANPS_TXHPB_ID_OFFSET XCANPS_TXBUF_DLC_OFFSET
to XCANPS_TXHPB_DLC_OFFSET XCANPS_TXBUF_DW1_OFFSET to XCANPS_TXHPB_DW1_OFFSET
XCANPS_TXBUF_DW2_OFFSET to XCANPS_TXHPB_DW2_OFFSET 2.1 adk 23/08/14 Fixed
CR:798792 Peripheral test for CANPS IP in SDK claims a 40kbps baud rate but it's
not. 3.0 adk 09/12/14 Added support for Zynq Ultrascale Mp.Also code modified
for MISRA-C:2012 compliance. 3.1 adk 10/11/15 Fixed CR911958 Add support for Tx
Watermark example. Data mismatch while sending data less than 8 bytes. 3.1 nsk
12/21/15 Updated XCanPs_IntrHandler in xcanps_intr.c to handle error interrupts
correctly. CR925615 ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_g.c @addtogroup
canps_v3_2 @{ This file contains a configuration table that specifies the
configuration of CAN devices in the system. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ----- -------- 1.00a xd/sv 01/12/10 First release 2.00 hk
22/01/14 Added check for picking second instance 3.00 kvn 02/13/15 Modified code
for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_hw.c @addtogroup
canps_v3_2 @{ This file contains the implementation of the canps interface reset
sequence <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.02a adk 08/08/13 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_hw.h @addtogroup
canps_v3_2 @{ This header file contains the identifiers and basic driver
functions (or macros) that can be used to access the device. Other driver
functions are defined in xcanps.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.00a xd/sv 01/12/10 First release 1.01a sbs
12/27/11 Updated the Register/bit definitions Changed XCANPS_RXFWIR_RXFLL_MASK
to XCANPS_WIR_FW_MASK Changed XCANPS_RXWIR_OFFSET to XCANPS_WIR_OFFSET Added
XCANPS_IXR_TXFEMP_MASK for Tx Fifo Empty Changed XCANPS_IXR_RXFLL_MASK to
XCANPS_IXR_RXFWMFLL_MASK Changed XCANPS_TXBUF_ID_OFFSET to
XCANPS_TXHPB_ID_OFFSET XCANPS_TXBUF_DLC_OFFSET to XCANPS_TXHPB_DLC_OFFSET
XCANPS_TXBUF_DW1_OFFSET to XCANPS_TXHPB_DW1_OFFSET XCANPS_TXBUF_DW2_OFFSET to
XCANPS_TXHPB_DW2_OFFSET 1.02a adk 08/08/13 Updated for including the function
prototype 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. </pre>

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_intr.c @addtogroup
canps_v3_2 @{ This file contains functions related to CAN interrupt handling.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a
xd/sv 01/12/10 First release 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. 3.1 nsk 12/21/15 Updated XCanPs_IntrHandler to handle error
interrupts correctly. CR925615 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_selftest.c @addtogroup
canps_v3_2 @{ This file contains a diagnostic self-test function for the XCanPs
driver. Read xcanps.h file for more information. @note The Baud Rate Prescaler
Register (BRPR) and Bit Timing Register(BTR) are setup such that CAN baud rate
equals 40Kbps, given the CAN clock equal to 24MHz. These need to be changed
based on the desired baudrate and CAN clock frequency. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv 01/12/10 First
release 2.1 adk 23/08/14 Fixed CR:798792 Peripheral test for CANPS IP in SDK
claims a 40kbps baud rate but it's not. 3.00 kvn 02/13/15 Modified code for
MISRA_C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcanps_sinit.c @addtogroup
canps_v3_2 @{ This file contains the implementation of the XCanPs driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a xd/sv 01/12/10 First release 3.00
kvn 02/13/15 Modified code for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/canps/src/xcanps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ----- ---------- 6.0 adk 03/06/14 FirstRelease 6.1 ms 01/16/17
Updated the parameter naming from XPAR_CCM_NUM_INSTANCES to
XPAR_XCCM_NUM_INSTANCES to avoid compilation failure for XPAR_CCM_NUM_INSTANCES
as the tools are generating XPAR_XCCM_NUM_INSTANCES in the generated xccm_g.c
for fixing MISRA-C files. This is a fix for CR-966099 based on the update in the
tools.

FILES:
XilinxProcessorIPLib/drivers/ccm/data/ccm.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ccm_selftest_example.c This
file contains an example using the XCCM driver to do self test on the device.
@note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- -------
-------- 6.00 adk 03/06/14 First Release. Implimented XCcmSelfTestExample
function. Adherence to Xilinx coding guidelines. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ccm/examples/ccm_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xccm.c @addtogroup ccm_v6_1 @{
This file contains the implementation of the interface functions for CCM driver.
Refer to the header file xccm.h for more detailed information. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 2.00a jo
05/1/10 Updated for CCM V2.0 3.00a ren 09/11/11 Updated for CCM v3.0 4.00a jj
12/18/12 Converted from xio.h to xil_io.h,translating basic types,MB cache
functions, exceptions and assertions to xil_io format. 6.0 adk 03/06/14 Changed
filename ccm.c to xccm.c. Implemented the following functions:
XCcm_CfgInitialize, XCcm_Setup, XCcm_GetVersion, XCcm_EnableDbgByPass,
XCcm_IsDbgByPassEnabled, XCcm_DisableDbgByPass, XCcm_EnableDbgTestPattern,
XCcm_IsDbgTestPatternEnabled, XCcm_DisableDbgTestPattern, XCcm_GetDbgFrameCount,
XCcm_GetDbgLineCount, XCcm_GetDbgPixelCount, XCcm_SetActiveSize,
XCcm_GetActiveSize, XCcm_SetCoefMatrix, XCcm_GetCoefMatrix, XCcm_SetRgbOffset,
XCcm_GetRgbOffset, XCcm_SetClip, XCcm_GetClip, XCcm_SetClamp and XCcm_GetClamp
XCcm_FloatToFixedConv, and XCcm_FixedToFloatConv. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ccm/src/xccm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xccm.h @addtogroup ccm_v6_1 @{
@details This header file contains identifiers and register-level driver
functions (or macros), range macros, structure typedefs that can be used to
access the Xilinx Color Correction Matrix (CCM) core instance. The Color
Correction Matrix core offers a 3x3 matrix multiplication for a variety of color
correction applications. CCM core provides following features: - Fully
programmable coefficient matrix. - Offset compensation. - Clipping and -
Clamping of the output. <b>Initialization & Configuration</b> The device driver
enables higher layer software (e.g., an application) to communicate to the CCM
core. XCcm_CfgInitialize() API is used to initialize the CCM core. The user
needs to first call the XCcm_LookupConfig() API which returns the Configuration
structure pointer which is passed as a parameter to the XCcm_CfgInitialize()
API. <b> Interrupts </b> The driver provides an interrupt handler
XCcm_IntrHandler for handling the interrupt from the CCM core. The users of this
driver have to register this handler with the interrupt system and provide the
callback functions by using XCcm_SetCallBack API. <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b> Building the driver </b> The XCcm
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 2.00a jo 05/1/10 Updated for
CCM V2.0. 3.00a ren 09/11/11 Updated for CCM V3.0. 4.00a jj 12/18/12 Converted
from xio.h to xil_io.h,translating basic types,MB cache functions, exceptions
and assertions to xil_io format. 5.0 adk 19/12/13 Updated as per the New Tcl
API's. 6.0 adk 03/06/14 Changed file name ccm.h to xccm.h. Moved register
offsets and bit definitions to xccm_hw.h file. Defined the following handler
types as enum values: XCCM_HANDLER_PROCSTART ,XCCM_HANDLER_FRAMEDONE and
XCCM_HANDLER_ERROR. Added the following range macros: XCCM_VSIZE_FIRST,
XCCM_VSIZE_LAST XCCM_HSIZE_FIRST, XCCM_HSIZE_LAST XCCM_COEF_FIRST,XCCM_COEF_LAST
XCCM_OFFSET_FIRST,XCCM_OFFSET_LAST XCCM_CLAMP_FIRST,XCCM_CLAMP_LAST
XCCM_CLIP_FIRST,XCCM_CLIP_LAST. Added the following structure type definitions:
XCcm_Config and XCcm. Removed the following functional macros: CCM_Enable,
CCM_Disable, CCM_RegUpdateEnable CCM_RegUpdateDisable, CCM_Reset,
CCM_AutoSyncReset CCM_ClearReset. Added the following macros: XCcm_Enable,
XCcm_Disable,XCcm_RegUpdateEnable, XCcm_SyncReset, XCcm_Reset,
XCcm_IntrGetPending, XCcm_IntrEnable, XCcm_IntrDisable, XCcm_StatusGetPending,
XCcm_IntrClear, XCcm_Start, XCcm_Stop. Modification history from xccm_hw.h First
release. Added the register offsets and bit masks for the registers. Added
backward compatibility macros. Modifications in the file xccm.c are: Changed
filename ccm to xccm.c. Implemented the following functions: XCcm_CfgInitialize,
XCcm_Setup, XCcm_GetVersion, XCcm_EnableDbgByPass, XCcm_IsDbgByPassEnabled,
XCcm_DisableDbgByPass, XCcm_EnableDbgTestPattern, XCcm_IsDbgTestPatternEnabled,
XCcm_DisableDbgTestPattern, XCcm_GetDbgFrameCount, XCcm_GetDbgLineCount,
XCcm_GetDbgPixelCount, XCcm_SetActiveSize, XCcm_GetActiveSize,
XCcm_SetCoefMatrix, XCcm_GetCoefMatrix, XCcm_SetRgbOffset, XCcm_GetRgbOffset,
XCcm_SetClip, XCcm_GetClip, XCcm_SetClamp XCcm_GetClamp XCcm_FloatToFixedConv,
and XCcm_FixedToFloatConv. Modifications in the file xccm_selftest.c are:
Implemented XCcm_SelfTest function. Modifications in the file xccm_sinit.c are:
Implemented XCcm_LookupConfig function. Modifications in the file xccm_intr.c
are: Implemented the following functions: XCcm_IntrHandler XCcm_SetCallBack 6.1
ms 01/16/17 Updated the parameter naming from XPAR_CCM_NUM_INSTANCES to
XPAR_XCCM_NUM_INSTANCES to avoid compilation failure for XPAR_CCM_NUM_INSTANCES
as the tools are generating XPAR_XCCM_NUM_INSTANCES in the generated xccm_g.c
for fixing MISRA-C files. This is a fix for CR-966099 based on the update in the
tools. ms 03/17/17 Added readme.txt file in examples folder for doxygen
generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/ccm/src/xccm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xccm_hw.h @addtogroup ccm_v6_1
@{ This header file contains identifiers and register-level driver functions (or
macros) that can be used to access the Xilinx Color Correction Matrix (CCM)
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------- --------
6.0 adk 03/06/14 First release. Added the register offsets and bit masks for the
registers. Added backward compatibility macros. </pre>

FILES:
XilinxProcessorIPLib/drivers/ccm/src/xccm_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xccm_intr.c @addtogroup
ccm_v6_1 @{ This file contains interrupt related functions of Xilinx CCM core.
Please see xccm.h for more details of the driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------- -------- 6.0 adk 03/06/14 First release.
Implemented the following functions: XCcm_IntrHandler and XCcm_SetCallBack.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ccm/src/xccm_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xccm_selftest.c @addtogroup
ccm_v6_1 @{ This file contains the self-test functions for the CCM core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 6.0 adk
03/06/14 First Release. Implemented XCcm_SelfTest function. </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/ccm/src/xccm_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xccm_sinit.c @addtogroup
ccm_v6_1 @{ This file contains static initialization methods for Xilinx CCM
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------- --------
6.0 adk 03/06/14 First release. Implemented XCcm_LookupConfig function. 6.1 ms
01/16/17 Updated the parameter naming from XPAR_CCM_NUM_INSTANCES to
XPAR_XCCM_NUM_INSTANCES to avoid compilation failure for XPAR_CCM_NUM_INSTANCES
as the tools are generating XPAR_XCCM_NUM_INSTANCES in the generated xccm_g.c
for fixing MISRA-C files. This is a fix for CR-966099 based on the update in the
tools. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ccm/src/xccm_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ----- ---------- 7.0 adk 01/07/14 FirstRelease 7.1 ms 01/16/17
Updated the parameter naming from XPAR_CFA_NUM_INSTANCES to
XPAR_XCFA_NUM_INSTANCES to avoid compilation failure for XPAR_CFA_NUM_INSTANCES
as the tools are generating XPAR_XCFA_NUM_INSTANCES in the generated xcfa_g.c
for fixing MISRA-C files. This is a fix for CR-966099 based on the update in the
tools.

FILES:
XilinxProcessorIPLib/drivers/cfa/data/cfa.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file cfa_selftest_example.c This
file contains an example using the XCfa driver to do self test on the device.
@note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------
-------- 1.00a drg/jz 01/13/10 First Release 1.03a sg 08/14/12 Updated the
example for CR 666306. Modified the device ID to use the first Device Id Removed
the printf at the start of the main 7.0 adk 01/15/14 Implimented main and
XCfaSelfTestExample functions. Adherence to MISRA C 2012 standard guidelines.
7.1 ms 01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfa/examples/cfa_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfa.c @addtogroup cfa_v7_1 @{
This file contains the implementation of the interface functions for CFA core.
Refer to the header file xcfa.h for more detailed information. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 drg/jz
01/13/10 First Release 3.00a gz 10/22/10 Updated for CFA V3.0 4.00a rc 09/11/11
Updated for CFA v4.0 5.00a se 12/01/11 Updated for CFA v5.0 7.0 adk 01/07/14
Changed the file name from cfa.c to xcfa.c Implemented the following functions:
XCfa_CfgInitialize, XCfa_Setup, XCfa_GetVersion, XCfa_EnableDbgByPass,
XCfa_IsDbgByPassEnabled, XCfa_DisableDbgBypass, XCfa_EnableDbgTestPattern,
XCfa_IsDbgTestPatternEnabled, XCfa_DisableDbgTestPattern, XCfa_GetDbgFrameCount
XCfa_GetDbgLineCount, XCfa_GetDbgPixelCount XCfa_SetActiveSize,
XCfa_GetActiveSize XCfa_SetBayerPhase, XCfa_GetBayerPhase, StubCallBack,
StubErrCallBack. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfa/src/xcfa.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfa.h @addtogroup cfa_v7_1 @{
@details This header file contains identifiers and register-level core functions
(or macros), range macros, structure typedefs that can be used to access the
Xilinx Color Filter Array Interpolation (CFA) core. The Color Filter Array
Interpolation core reconstructs a color image from an RGB or CMY Bayer filtered
sensor using a 5x5 interpolation aperture. The core is capable of a maximum
resolution of 7680 columns by 7680 rows with 8, 10, or 12 bits per pixel and
supports the bandwidth necessary for High-definition (1080p60) resolutions in
all Xilinx FPGA device families. Higher resolutions can be supported in Xilinx
high-performance device families. <b>Initialization & Configuration</b> The
device driver enables higher layer software (e.g., an application) to
communicate to the CFA core. XCfa_CfgInitialize() API is used to initialize the
CFA core. The user needs to first call the XCfa_LookupConfig() API which returns
the Configuration structure pointer which is passed as a parameter to the
XCfa_CfgInitialize() API. <b> Interrupts </b> The driver provides an interrupt
handler XCfa_IntrHandler for handling the interrupt from the CFA core. The users
of this driver have to register this handler with the interrupt system and
provide the callback functions by using XCfa_SetCallBack API. <b> Virtual Memory
</b> This driver supports Virtual Memory. The RTOS is responsible for
calculating the correct device base address in Virtual Memory space. <b> Threads
</b> This driver is not thread safe. Any needs for threads or thread mutual
exclusion must be satisfied by the layer above this driver. <b> Asserts </b>
Asserts are used within all Xilinx drivers to enforce constraints on argument
values. Asserts can be turned off on a system-wide basis by defining, at compile
time, the NDEBUG identifier. By default, asserts are turned on and it is
recommended that users leave asserts on during development. <b> Building the
driver </b> The XCfa driver is composed of several source files. This allows the
user to build and link only those parts of the driver that are necessary. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a xd
08/05/08 First release 3.00a gz 10/22/10 Updated for CFA V3.0 4.00a rc 09/11/11
Updated for CFA v4.0 5.00a se 12/01/11 Updated for CFA v5.0, replaced xio.h with
xil_io.h. 6.0 adk 19/12/13 Updated as per the New Tcl API's. 7.0 adk 01/07/14
Changed the file name from cfa.h to xcfa.h Defined following handler types as
enum XCFA_HANDLER_PROCSTART, XCFA_HANDLER_FRAMEDONE, XCFA_HANDLER_ERROR. Defined
the BayerPhaseCombination enum for bayerphase combinations. Defined the
following macros: XCFA_VSIZE_FIRST, XCFA_VSIZE_LAST XCFA_HSIZE_FIRST,
XCFA_HSIZE_LAST XCfa_Start, XCfa_Stop, XCfa_IntrEnable, XCfa_IntrDisable,
XCfa_StatusGetPending, XCfa_IntrGetPending, XCfa_IntrClear. Added the following
function macros: XCfa_Enable, XCfa_Disable, XCfa_Reset, XCfa_SyncReset,
XCfa_RegUpdateEnable, XCfa_RegUpdateDisable. Removed the following functional
macros: CFA_Enable, CFA_Disable, CFA_Reset, CFA_FSyncReset,
XCFA_RegUpdateEnable, XCFA_RegUpdateDisable, CFA_ClearReset, CFA_ClearStatus.
Defined the following type definitions: XCfa_Config and XCfa structures.
XCfa_CallBack and XCfa_ErrorCallBack. Changes in xcfa_hw.h: Added the register
offsets and bit masks for the registers and added backward compatibility for
macros. Changes in xcfa.c: Renamed this file as below: cfa.c -> xcfa.c
Implemented the following functions: XCfa_CfgInitialize, XCfa_Setup,
XCfa_GetVersion, XCfa_EnableDbgByPass, XCfa_IsDbgByPassEnabled,
XCfa_DisableDbgBypass, XCfa_EnableDbgTestPattern, XCfa_IsDbgTestPatternEnabled,
XCfa_DisableDbgTestPattern, XCfa_GetDbgFrameCount, XCfa_GetDbgLineCount,
XCfa_GetDbgPixelCount, XCfa_SetActiveSize, XCfa_GetActiveSize,
XCfa_SetBayerPhase, XCfa_GetBayerPhase, StubCallBack, StubErrCallBack. Changes
in xcfa_intr.c: Implemented the following functions: XCfa_IntrHandler,
XCfa_SetCallBack. Changes in xcfa_selftest.c: Implemented XCfa_SelfTest
function. Changes in xcfa_sinit.c : Implemented XCfa_LookupConfig function. 7.1
ms 01/16/17 Updated the parameter naming from XPAR_CFA_NUM_INSTANCES to
XPAR_XCFA_NUM_INSTANCES to avoid compilation failure for XPAR_CFA_NUM_INSTANCES
as the tools are generating XPAR_XCFA_NUM_INSTANCES in the generated xcfa_g.c
for fixing MISRA-C files. This is a fix for CR-966099 based on the update in the
tools. ms 01/23/17 Added xil_printf statement in main function for all examples
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/cfa/src/xcfa.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfa_hw.h @addtogroup cfa_v7_1
@{ This header file contains identifiers and register-level driver functions (or
macros) that can be used to access the Xilinx Color Filter Array Interpolation
(CFA) core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 7.0 adk 01/07/14 First release. Added the register offsets and bit
masks for the registers and added backward compatibility for macros. </pre>

FILES:
XilinxProcessorIPLib/drivers/cfa/src/xcfa_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfa_intr.c @addtogroup
cfa_v7_1 @{ This file contains interrupt related functions of the CFA core.
Please see xcfa.h for more details of the core. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 7.0 adk 01/07/14 First release.
Implemented the following functions: XCfa_IntrHandler, XCfa_SetCallBack. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfa/src/xcfa_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfa_selftest.c @addtogroup
cfa_v7_1 @{ This file contains the self-test functions for the CFA core. The
self test function reads the Version register. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------- -------- 7.0 adk 01/07/14 First Release
Implemented XCfa_SelfTest function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfa/src/xcfa_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfa_sinit.c @addtogroup
cfa_v7_1 @{ This file contains static initialization methods for Xilinx CFA
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 7.0
adk 01/07/14 First release. Implemented XCfa_LookupConfig function. 7.1 ms
01/16/17 Updated the parameter naming from XPAR_CFA_NUM_INSTANCES to
XPAR_XCFA_NUM_INSTANCES to avoid compilation failure for XPAR_CFA_NUM_INSTANCES
as the tools are generating XPAR_XCFA_NUM_INSTANCES in the generated xcfa_g.c
for fixing MISRA-C files. This is a fix for CR-966099 based on the update in the
tools. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfa/src/xcfa_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 kc 22/10/17 First release uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/cframe/data/cframe.tcl
XilinxProcessorIPLib/drivers/cfupmc/data/cfupmc.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF PLRCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEPLNT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcframe.c This file which
contains the code related to CFRAME block. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 11/10/2017 Initial release 1.01 bsv
29/05/2019 XCframe_ReadReg API added 1.02 bsv 11/06/2019 XCframe_ClearCframeErr
API added </pre> @note Include Files /

FILES:
XilinxProcessorIPLib/drivers/cframe/src/xcframe.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF PLRCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEPLNT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcframe.h This is the file
which contains header files related to CFRAME block <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 12/21/2017 Initial release 1.01
bsv 06/11/2019 Added XCframe_ClearCframeErr API </pre> @note

FILES:
XilinxProcessorIPLib/drivers/cframe/src/xcframe.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

CAUTION: This file is automatically generated by HSI. Version: DO NOT EDIT. All
Rights Reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
Software), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED AS IS,
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: Driver configuration

FILES:
XilinxProcessorIPLib/drivers/cframe/src/xcframe_g.c
XilinxProcessorIPLib/drivers/cfupmc/src/xcfupmc_g.c
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_g.c
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss_g.c
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_g.c
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_g.c
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu_g.c
XilinxProcessorIPLib/drivers/spdif/src/xspdif_g.c
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv_g.c
XilinxProcessorIPLib/drivers/v_multi_scaler/src/xv_multi_scaler_g.c
XilinxProcessorIPLib/drivers/v_scenechange/src/xv_scenechange_g.c
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie_g.c
lib/sw_apps/zynqmp_pmufw/misc/xwdtps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcframe_hw.h @addtogroup
cframe_v1_0 @{ This header file contains identifiers and register-level driver
functions (or macros) that can be used to access the Xilinx CFRAME core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kc 22/10/17
First release 1.1 bsv 29/05/2019 Macros declared for CFRM_ISR_OFFSET,
CFRM_IER_OFFSET and STATUS_OFFSET </pre>

FILES:
XilinxProcessorIPLib/drivers/cframe/src/xcframe_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcframe_selftest.c @addtogroup
cframe_v1_0 @{ This file contains a diagnostic self-test function for the CFU
driver. Refer to the header file xcframe.h for more detailed information. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kc
22/10/2017 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cframe/src/xcframe_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcframe_sinit.c @addtogroup
cframe_v1_0 @{ This file contains static initialization methods for Xilinx
CFRAME core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kc 22/10/2017 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cframe/src/xcframe_sinit.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.87 XREGCHDR v0.15 Generated on: 2018-02-16 @file:
cfu_apb.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
XilinxProcessorIPLib/drivers/cfupmc/src/cfu_apb.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF PLRCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEPLNT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfupmc.c This file which
contains the code related to CFU block. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 12/21/2017 Initial release 2.00 bsv
03/01/2019 Added error handling APIs 2.01 bsv 11/06/2019 XCfupmc_ClearCfuIsr API
added </pre> @note Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfupmc/src/xcfupmc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF PLRCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEPLNT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfupmc.h This is the file
which contains code for CFU block. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 12/21/2017 Initial release 2.00 bsv
03/01/2019 Added error handling APIs 2.01 bsv 11/06/2019 XCfupmc_ClearCfuIsr API
added </pre> @note

FILES:
XilinxProcessorIPLib/drivers/cfupmc/src/xcfupmc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfupmc_hw.h @addtogroup
cfupmc_v1_0 @{ This header file contains identifiers and register-level driver
functions (or macros) that can be used to access the Xilinx CFU core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kc 22/10/17
First release </pre>

FILES:
XilinxProcessorIPLib/drivers/cfupmc/src/xcfupmc_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfupmc_selftest.c @addtogroup
cfupmc_v1_0 @{ This file contains a diagnostic self-test function for the CFU
driver. Refer to the header file xcfupmc.h for more detailed information. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kc 22/10/17
First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfupmc/src/xcfupmc_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcfupmc_sinit.c @addtogroup
cfupmc_v1_0 @{ This file contains static initialization methods for Xilinx CFU
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0
kc 22/10/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cfupmc/src/xcfupmc_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 ram 02/15/16 Initial version for Clock
Wizard 1.1 siv 08/17/16 Added support for 64-bit addressing

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/data/clk_wiz.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 ram 02/15/16 Initial version for Clock
Wizard 1.1 siv 08/17/16 Added support for Zynq MPSoC and 64-bit uses
"xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/data/clk_wiz.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 ram 02/15/16 Initial version for Clock
Wizard 1.1 siv 08/17/16 Added support for Zynq MPSoC and 64-bit addressing
@BEGIN_CHANGELOG EDK_I - include header files @END_CHANGELOG @BEGIN_CHANGELOG
EDK_H - Initial Revision @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl
Software Project Types (swproj): 0 : MemoryTest - Calls basic memorytest
routines from common driver dir 1 : PeripheralTest - Calls any existing
polled_example and/or selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/data/clk_wiz_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz_intr_example.c This
file contains a design example using the XClk_Wiz driver with interrupts it will
generate interrupt for clok glitch, clock overflow and underflow The user should
have setup with 2 clocking wizard instances, one instance act as clocking
monitor (Enable clock monitor in GUI), In another instance enable dynamic clock
reconfiguration. In the present example XCLK_WIZ_DYN_DEVICE_ID assigned to clock
wizard 1. Modify this value as per your dynamic clock reconfiguration Clocking
wizard @note This example requires an interrupt controller connected to the
processor and the MIPI CLK_WIZ in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 ram 2/12/16 Initial version for Clock
Wizard 1.1 ms 01/23/17 Modified xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/examples/xclk_wiz_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz.c @addtogroup
clk_wiz_v1_2 @{ This file implements the functions to get the CLK_WIZ GUI
information and Clock Monitor Interrupt status <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 ram 2/12/16 Initial version for Clock
Wizard 1.1 siv 8/17/16 Used UINTPTR instead of u32 for Baseaddress Changed the
prototype of XClk_Wiz_CfgInitialize 1.2 ms 3/02/17 Fixed compilation warnings.
Fix for CR-970507. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/src/xclk_wiz.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz.h @addtogroup
clk_wiz_v1_2 @{ @details This is main header file of the Xilinx Clock Wizard
driver <b>Clock wizard Overview</b> The Clock monitor feature is a part of
Clocking Wizard IP. It allows a user to monitor the clock in a given system for
clock loss, out of range.In Zynq or Zynq Ultrascale, the clock monitored can be
either a PS or a PL clock. In FPGAs, the clock monitored can be an arbitrary
clock. <b>Clock wizard Features</b> - Clock Stop  The clock is flat lined. -
Clock Glitch  Variation in the duty cycle of the clock. - Overrun - The number
of transitions in the clock are more than expected - Underrun - The number of
transitions in the clock are less than expected. - Overrun and Underrun are
termed as out of range errors. <b>Clock Monitor Configurations</b> - The GUI
in IPI allows for the following configurations - Enable 4 User clocks - Enable
User clock PLL. - Select reference clock frequency - Select 4 user clock
frequencies <b>Pre-Requisite's</b> <b>Subsystem Driver Usage</b> <b>Memory
Requirement</b> <b>Interrupt Service</b> <b>Virtual Memory </b> This driver
supports Virtual Memory. The RTOS is responsible for calculating the correct
device base address in Virtual Memory space. <b>Threads </b> This driver is not
thread safe. Any needs for threads or thread mutual exclusion must be satisfied
by the layer above this driver. <b>Asserts</b> Asserts are used within all
Xilinx drivers to enforce constraints on argument values. Asserts can be turned
off on a system-wide basis by defining, at compile time, the NDEBUG identifier.
By default, asserts are turned on and it is recommended that application
developers leave asserts on during development. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 ram 02/12/16 Initial version for Clock
Wizard 1.1 ms 01/23/17 Modified xil_printf statement in main function for all
examples to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. 1.2 ms 03/02/17 Fixed compilation
errors in xclk_wiz_intr.c, xclk_wiz_g.c and warnings in xclk_wiz.c files. Fix
for CR-970507. ms 03/17/17 Added readme.txt file in examples folder for doxygen
generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/src/xclk_wiz.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz_hw.h @addtogroup
clk_wiz_v1_2 @{ Hardware definition file. It defines the register interface.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 ram
02/12/16 Initial version for Clock Wizard </pre> /

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/src/xclk_wiz_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz_intr.c @addtogroup
clk_wiz_v1_2 @{ This file implements the functions which handle the interrupts
in the CLK_WIZ Controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 ram 02/12/16 Initial version for Clock Wizard 1.2 ms
03/02/17 Fixed compilation errors. Fix for CR-970507. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/src/xclk_wiz_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz_sinit.c @addtogroup
clk_wiz_v1_2 @{ Look up the hardware settings using device ID. The hardware
setting is inside the configuration table in xclk_wiz_g.c, generated
automatically by XPS or manually by the user. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 ram 02/12/16 Initial version for Clock
Wizard </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clk_wiz/src/xclk_wiz_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_example.c This file
contains a design example using the Clock Controller (ClockPs) driver. It uses
I2C peripheral clock for clock operations @note <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.00 cjp 2/20/18 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/examples/xclockps_i2c_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps.c @addtogroup
xclockps_v1_0 @{ Contains the implementation of interface functions of the clock
driver. See xclock.h for a description of the driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp 02/09/18 First
release 1.00 sd 07/26/18 Fix coverity warnings 1.1 aru 03/20/19 Fix IAR issue by
changing "XCLOCK_ABS_DIFF" to a function named "XClock_Absolute_Difference".
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps.h @addtogroup
xclock_v1_0 @{ The Xilinx Clock controller driver provides APIs to control clock
parameters. Below are the feature of the driver: - Manages database for mux,
plls, gates, dividers and fixed factors for all the supported clocks. - Allows
to enable/disable specific clock. - Allows to change the parent for specific
clock. - Allows to get/set rate for specific clock. This driver is intended to
be RTOS and processor independent. It works with physical addresses only. Any
needs for dynamic memory management, threads or thread mutual exclusion, virtual
memory, or cache control must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp
02/09/18 First release 1.00 sd 07/26/18 Fix Doxygen warnings 1.1 aru 03/20/19
Fix IAR issue by changing "XCLOCK_ABS_DIFF" to a function named
"XClock_Absolute_Difference". </pre>

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_divider.c @addtogroup
xclockps_v1_0 @{ Contains the implementation of interface functions of the clock
driver. See xclock.h for a description of the driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp 02/09/18 First
release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_divider.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_fixedfactor.c
@addtogroup xclockps_v1_0 @{ This file handles fixed factor related definition
and operations. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 cjp 02/09/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_fixedfactor.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_g.c @addtogroup
xclockps_v1_0 @{ This file contains a table that specifies the configuration of
the clocking in the system. Each device should have an entry in the table. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp
02/09/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_gate.c @addtogroup
xclockps_v1_0 @{ This file handles Gate related definitions and operations <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp
02/09/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_gate.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_hw.h @addtogroup
xclock_v1_0 @{ This file contains the hardware details for the System Clock
controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 cjp 02/09/18 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_mux.c @addtogroup
xclockps_v1_0 @{ This file handles Mux related definition and operations. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp
02/09/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_mux.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_pll.c @addtogroup
xclockps_v1_0 @{ This file handles PLL related definition and operations. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp
02/09/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_pll.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclockps_sinit.c @addtogroup
xclockps_v1_0 @{ This file contains method for static initialization (compile-
time) of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 cjp 02/09/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/clockps/src/xclockps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbasic_types.c @addtogroup
common_v1_00_a @{ This file contains basic functions for Xilinx software IP.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpm
11/07/03 Added XNullHandler function as a stub interrupt handler 1.00a xd
11/03/04 Improved support for doxygen. 1.00a bss 13/01/12 Removed a compiler
warning in XNullHandler; </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/common/src/xbasic_types.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbasic_types.h @addtogroup
common_v1_00_a @{ This file contains basic types for Xilinx software IP. These
types do not follow the standard naming convention with respect to using the
component name in front of each name because they are considered to be
primitives. @note This file contains items which are architecture dependent.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm
12/14/01 First release rmm 05/09/03 Added "xassert always" macros to rid
ourselves of diab compiler warnings 1.00a rpm 11/07/03 Added XNullHandler
function as a stub interrupt handler 1.00a rpm 07/21/04 Added XExceptionHandler
typedef for processor exceptions 1.00a xd 11/03/04 Improved support for doxygen.
1.00a wre 01/25/07 Added Linux style data types u32, u16, u8, TRUE, FALSE 1.00a
rpm 04/02/07 Added ifndef KERNEL around u32, u16, u8 data types </pre>

FILES:
XilinxProcessorIPLib/drivers/common/src/xbasic_types.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenv.h @addtogroup
common_v1_00_a @{ Defines common services that are typically found in a host
operating. environment. This include file simply includes an OS specific file
based on the compile-time constant BUILD_ENV_, where is the name of the target
environment. All services are defined as macros. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00b ch 10/24/02 Added XENV_LINUX 1.00a
rmm 04/17/02 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/common/src/xenv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenv_linux.h @addtogroup
common_v1_00_a @{ Defines common services specified by xenv.h. @note This file
is not intended to be included directly by driver code. Instead, the generic
xenv.h file is intended to be included by driver code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wgr 02/28/07 Added cache
handling macros. 1.00a wgr 02/27/07 Simplified code. Deprecated old-style macro
names. 1.00a xd 11/03/04 Improved support for doxygen. 1.00a ch 10/24/02 First
release 1.10a wgr 03/22/07 Converted to new coding style. </pre>

FILES:
XilinxProcessorIPLib/drivers/common/src/xenv_linux.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenv_none.h @addtogroup
common_v1_00_a @{ This is a legacy file kept for backwards compatibility. Please
modify your code to include "xenv_standalone.h" instead.

FILES:
XilinxProcessorIPLib/drivers/common/src/xenv_none.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenv_standalone.h @addtogroup
common_v1_00_a @{ Defines common services specified by xenv.h. @note This file
is not intended to be included directly by driver code. Instead, the generic
xenv.h file is intended to be included by driver code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wgr 02/28/07 Added cache
handling macros. 1.00a wgr 02/27/07 Simplified code. Deprecated old-style macro
names. 1.00a rmm 01/24/06 Implemented XENV_USLEEP. Assume implementation is
being used under Xilinx standalone BSP. 1.00a xd 11/03/04 Improved support for
doxygen. 1.00a rmm 03/21/02 First release 1.00a wgr 03/22/07 Converted to new
coding style. 1.00a rpm 06/29/07 Added udelay macro for standalone 1.00a xd
07/19/07 Included xparameters.h as XPAR_ constants are referred to in MICROBLAZE
section 1.00a ecm 09/19/08 updated for v7.20 of Microblaze, new functionality
</pre>

FILES:
XilinxProcessorIPLib/drivers/common/src/xenv_standalone.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenv_vxworks.h @addtogroup
common_v1_00_a @{ Defines common services specified by xenv.h. @note This file
is not intended to be included directly by driver code. Instead, the generic
xenv.h file is intended to be included by driver code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wgr 02/28/07 Added cache
handling macros. 1.00a wgr 02/27/07 Simplified code. Deprecated old-style macro
names. 1.00a xd 11/03/04 Improved support for doxygen. rmm 09/13/03 CR 177068:
Fix compiler warning in XENV_MEM_FILL rmm 10/24/02 Added XENV_USLEEP macro 1.00a
rmm 07/16/01 First release 1.10a wgr 03/22/07 Converted to new coding style.
</pre>

FILES:
XilinxProcessorIPLib/drivers/common/src/xenv_vxworks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters.h @addtogroup
common_v1_00_a @{ This file contains system parameters for the Xilinx device
driver environment. It is a representation of the system in that it contains the
number of each device in the system as well as the parameters and memory map for
each device. The user can view this file to obtain a summary of the devices in
their system and the device parameters. This file may be automatically generated
by a design tool such as System Generator. Include Files /

FILES:
XilinxProcessorIPLib/drivers/common/src/xparameters.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xstatus.h @addtogroup
common_v1_00_a @{ This file contains Xilinx software status codes. Status codes
have their own data type called int. These codes are used throughout the Xilinx
device drivers.

FILES:
XilinxProcessorIPLib/drivers/common/src/xstatus.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xutil.h @addtogroup
common_v1_00_a @{ This file contains utility functions such as memory test
functions. <b>Memory test description</b> A subset of the memory tests can be
selected or all of the tests can be run in order. If there is an error detected
by a subtest, the test stops and the failure code is returned. Further tests are
not run even if all of the tests are selected. Subtest descriptions: <pre>
XUT_ALLMEMTESTS: Runs all of the following tests XUT_INCREMENT: Incrementing
Value Test. This test starts at 'XUT_MEMTEST_INIT_VALUE' and uses the
incrementing value as the test value for memory. XUT_WALKONES: Walking Ones
Test. This test uses a walking '1' as the test value for memory. location 1
0x00000001 location 2 0x00000002 ... XUT_WALKZEROS: Walking Zero's Test. This
test uses the inverse value of the walking ones test as the test value for
memory. location 1 0xFFFFFFFE location 2 0xFFFFFFFD ... XUT_INVERSEADDR: Inverse
Address Test. This test uses the inverse of the address of the location under
test as the test value for memory. XUT_FIXEDPATTERN: Fixed Pattern Test. This
test uses the provided patters as the test value for memory. If zero is provided
as the pattern the test uses '0xDEADBEEF". </pre> <i>WARNING</i> The tests are
<b>DESTRUCTIVE</b>. Run before any initialized memory spaces have been set up.
The address, Addr, provided to the memory tests is not checked for validity
except for the NULL case. It is possible to provide a code-space pointer for
this test to start with and ultimately destroy executable code causing random
failures. @note Used for spaces where the address range of the region is smaller
than the data width. If the memory range is greater than 2 width, the patterns
used in XUT_WALKONES and XUT_WALKZEROS will repeat on a boundary of a power of
two making it more difficult to detect addressing errors. The XUT_INCREMENT and
XUT_INVERSEADDR tests suffer the same problem. Ideally, if large blocks of
memory are to be tested, break them up into smaller regions of memory to allow
the test patterns used not to repeat over the region tested. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm 11/01/01 First
release 1.00a xd 11/03/04 Improved support for doxygen. </pre>

FILES:
XilinxProcessorIPLib/drivers/common/src/xutil.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xutil_memtest.c @addtogroup
common_v1_00_a @{ Contains the memory test utility functions. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm 11/01/01 First
release 1.00a xd 11/03/04 Improved support for doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/common/src/xutil_memtest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xversion.c @addtogroup
common_v1_00_a @{ This file contains the implementation of the XVersion
component. This component represents a version ID. It is encapsulated within a
component so that it's type and implementation can change without affecting
users of it. The version is formatted as X.YYZ where X 0 - 9, Y 00 - 99, Z a - z
X is the major revision, YY is the minor revision, and Z is the compatibility
revision. Packed versions are also utilized for the configuration ROM such that
memory is minimized. A packed version consumes only 16 bits and is formatted as
follows. <pre> Revision Range Bit Positions Major Revision 0 - 9 Bits 15 - 12
Minor Revision 0 - 99 Bits 11 - 5 Compatibility Revision a - z Bits 4 - 0
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a xd 11/03/04
Improved support for doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/common/src/xversion.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xversion.h @addtogroup
common_v1_00_a @{ This file contains the interface for the XVersion component.
This component represents a version ID. It is encapsulated within a component so
that it's type and implementation can change without affecting users of it. The
version is formatted as X.YYZ where X 0 - 9, Y 00 - 99, Z a - z X is the major
revision, YY is the minor revision, and Z is the compatibility revision. Packed
versions are also utilized for the configuration ROM such that memory is
minimized. A packed version consumes only 16 bits and is formatted as follows.
<pre> Revision Range Bit Positions Major Revision 0 - 9 Bits 15 - 12 Minor
Revision 0 - 99 Bits 11 - 5 Compatibility Revision a - z Bits 4 - 0 MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a xd 11/03/04 Improved
support for doxygen. </pre>

FILES:
XilinxProcessorIPLib/drivers/common/src/xversion.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/27/14 Initial version "generate"
procedure

FILES:
XilinxProcessorIPLib/drivers/coresightps_dcc/data/coresightps_dcc.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcoresightpsdcc.c @addtogroup
coresightps_dcc_v1_6 @{ Functions in this file are the minimum required
functions for the XCoreSightPs driver. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ----- -------- 1.00 kvn 02/14/15 First release 1.1
kvn 06/12/15 Add support for Zynq Ultrascale+ MP. kvn 08/18/15 Modified Makefile
according to compiler changes. 1.2 kvn 10/09/15 Add support for IAR Compiler.
1.3 asa 07/01/16 Made changes to ensure that the file does not compile for MB
BSPs. Instead it throws up a warning. This fixes the CR953056. 1.5 sne 01/19/19
Fixed MISRA-C Violations CR1025101. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/coresightps_dcc/src/xcoresightpsdcc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcoresightpsdcc.h @addtogroup
coresightps_dcc_v1_6 @{ @details CoreSight driver component. The coresight is a
part of debug communication channel (DCC) group. Jtag UART for ARM uses DCC.
Each ARM core has its own DCC, so one need to select an ARM target in XSDB
console before running the jtag terminal command. Using the coresight driver
component, the output stream can be directed to a log file. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00 kvn
02/14/15 First release 1.1 kvn 06/12/15 Add support for Zynq Ultrascale+ MP. kvn
08/18/15 Modified Makefile according to compiler changes. 1.3 asa 07/01/16 Made
changes to ensure that the file does not compile for MB BSPs. Instead it throws
up a warning. This fixes the CR953056. 1.5 sne 01/19/19 Fixed MISRA-C Violations
CR1025101. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/coresightps_dcc/src/xcoresightpsdcc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 2.3 sk 12/15/14 Deleted �ffunction-sections &
-fdata-sections flags from extra compiler flags CR838648 Changed default os to
latest version. 2.6 mus 12/20/16 Added "ffunction-sections" and "fdata-sections"
to the default extra compiler flags.Also, "-g" is removed from the default extra
compiler flags. 2.6 mus 01/24/17 Added "-Wall -Wextra" to extra_compiler_flags
2.7 vns 04/13/18 Modified post_generate proc to post_generate_final 2.8 mga
06/27/18 Added -Os and LTO to extra_compiler_flags for pmu bsp 2.10 mus 04/16/19
Replace XILINX_SDK env variable with RDI_APPROOT. Fix for CR1028460. aru
04/18/19 Updated to add Assembler support

FILES:
XilinxProcessorIPLib/drivers/cpu/data/cpu.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @BEGIN_CHANGELOG EDK_L Updated the
Tcl to add the bus frequency to xparameters.h @END_CHANGELOG @BEGIN_CHANGELOG
EDK_LS3 Updated the Tcl to check for Extended FPU for pulling in libm compiled
with -mhard-float @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3 Updated the Tcl to
pull appropriate libraries for Little Endian Microblaze @END_CHANGELOG
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.04a asa
07/16/12 Updated the tcl to return 100 MHz for CR 668726 for an IP integrator
design when when cpu is directly connected to axi slave peripheral 2.0 adk
10/12/13 Updated as per the New Tcl API's 2.1 bss 04/14/14 Updated to copy
libgloss.a and libgcc.a libraries 2.1 bss 04/29/14 Updated to copy libgloss.a if
exists otherwise libxil.a CR794205 2.2 bss 08/04/14 Updated to add protection
macros for xparameters.h CR802257 2.4 nsk 11/05/15 Updated generate and
post_generate procs, not to generate cpu macros, when microblaze is connected as
one of the streaming slaves to itself. CR876604 2.5 asa 04/20/16 Fix for
CR947179. While populating the CPU_CORE_FREQ first look for "Clk" pin and if not
found use the CONFIG param C_FREQ for microblaze to populate the
CPU_CORE_FREQ_HZ. 2.7 vns 04/13/18 Modified post_generate proc to
post_generate_final 2.7 mus 04/17/18 Updated the generate proc to add HW
parameter based compiler flags for microblaze. Till now this setting was being
done by HSI. 2.8 mga 06/27/18 Added -Os and LTO to extra_compiler_flags for pmu
bsp 2.8 mus 09/11/18 Added support for Microblaze-X 2.10 mus 04/16/19 Replace
XILINX_SDK env variable with HDI_APPROOT. Fix for CR1028460. uses xillib.tcl
Make file writable

FILES:
XilinxProcessorIPLib/drivers/cpu/data/cpu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fsl.h @addtogroup cpu_v2_9 @{
This file contains macros for interfacing to the Fast Simplex Link (FSL)
interface.. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a ecm 06/20/07 Initial version, moved over from bsp area 1.11c ecm 08/26/08
Fixed the missing 'FSL_DEFAULT' define that was causing assembly errors. </pre>
@note None.

FILES:
XilinxProcessorIPLib/drivers/cpu/src/fsl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xio.c @addtogroup cpu_v2_9 @{
Contains I/O functions for memory-mapped or non-memory-mapped I/O architectures.
These functions encapsulate generic CPU I/O requirements. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpm 11/07/03 Added
InSwap/OutSwap routines for endian conversion 1.01a ecm 02/24/06 CR225908
corrected the extra curly braces in macros and bumped version to 1.01.a. 2.11a
mta 03/21/07 Updated to new coding style. </pre> @note This file may contain
architecture-dependent code. Include Files /

FILES:
XilinxProcessorIPLib/drivers/cpu/src/xio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xio.h @addtogroup cpu_v2_9 @{
@details This file contains the interface for the XIo component, which
encapsulates the Input/Output functions for processors that do not require any
special I/O handling. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a rpm 11/07/03 Added InSwap/OutSwap routines for endian
conversion 1.00a xd 11/04/04 Improved support for doxygen 1.01a ecm 02/24/06
CR225908 corrected the extra curly braces in macros and bumped version to
1.01.a. 1.11a mta 03/21/07 Updated to new coding style. 1.11b va 04/17/08
Updated Tcl for better CORE_CLOCK_FREQ_HZ definition 1.11a sdm 03/12/09 Updated
Tcl to define correct value for CORE_CLOCK_FREQ_HZ (CR 502010) 1.13a sdm
03/12/09 Updated the Tcl to pull appropriate libraries for Little Endian
Microblaze 2.0 adk 19/12/13 Updated as per the New Tcl API's 2.1 bss 04/14/14
Updated tcl to copy libgloss.a and libgcc.a libraries 2.1 bss 04/29/14 Updated
to copy libgloss.a if exists otherwise libxil.a CR794205 2.2 bss 08/04/14
Updated driver tcl to add protection macros for xparameters.h (CR802257). 2.3 sk
12/15/14 Updated mdd file to delete �ffunction-sections & -fdata-sections
flags from extra compiler flags CR838648 Changed default os to latest version in
mdd file. 2.4 nsk 11/05/15 Updated generate and post_generate procs in driver
tcl not to generate cpu macros, when microblaze is connected as one of the
streaming slaves to itself. CR876604 </pre> @note This file may contain
architecture-dependent items (memory-mapped or non-memory-mapped I/O).

FILES:
XilinxProcessorIPLib/drivers/cpu/src/xio.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 pkp 07/21/14 Initial common::version 1.3 mus
02/20/17 Updated tcl to guard xparameters.h by protection macros 1.4 ms 04/18/17
Modified tcl file to add suffix U for XPAR_CPU_ID parameter of cpu_cortexa53 in
xparameters.h 1.4 mus 07/26/17 Updated extra compiler flags for a53 32 bit
processor by appending "-mfpuvfpv3 -mfloat-abihard". This change has been done
to support hard floating point operations for a53 32 bit BSP. 1.5 mus 09/18/17
Updated to check each extra compiler flag individually for Cortexa53 32 mode
BSP.This change allows users to modify default flag value.It fixes CR984945. 1.6
mus 01/30/18 Updated to support armclang compiler aru 04/18/19 Updated to add
Assembler support for armclang uses "xillib.tcl" "generate" procedure

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexa53/data/cpu_cortexa53.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcpu_cortexa53.h @addtogroup
cpu_cortexa53_v1_5 @{ @details dummy file MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.4 ms 04/18/17 Modified tcl file to add suffix U
for XPAR_CPU_ID parameter of cpu_cortexa53 in xparameters.h @} /

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexa53/src/xcpu_cortexa53.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 mus 09/20/17 Initial version uses "xillib.tcl"
"generate" procedure

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexa72/data/cpu_cortexa72.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcpu_cortexa72.h @addtogroup
cpu_cortexa72_v1_0 @{ @details dummy file MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 mus 09/20/17 Initial version @} /

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexa72/src/xcpu_cortexa72.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 05/16/10 Updated to support AXI
common::version of the core 2.0 adk 10/12/13 Updated as per the New Tcl API's
2.1 pkp 06/27/14 Updated the tcl to create empty libxil for IAR support in BSP
2.2 pkp 02/24/16 Updated tcl for extra compiler flags different toochain 2.2 pkp
03/02/16 Append the extra compiler flag only when it contains any extra flags
apart from default ones for linaro toolchain 2.2 pkp 03/02/16 Added
--cpuCortex-A9 compiler flag for iccarm 2.2 asa 03/05/16 Updated for accepting
only the toolchain name when a complete path is passed. Also made changes to
have separate case for code sourcery (arm-xilinx-eabi-gcc) and armcc while
generating extra_compiler_flags. These changes fix CR939108. 2.3 pkp 06/24/16
Updated tcl to remove logic for removing extra space and update the extra
compiler flag for particular compiler only when some flag apart from default
while generating BSP. These modifications fix CR951335 2.4 pkp 12/23/16 Updated
tcl to check each extra compiler flag individually for linaro toolchain and if
any default flags are missing, it adds the required flags. This change allows
users to modify default flag value. This change fixes CR965023. 2.4 mus 01/24/17
Updated tcl to add "-Wall -Wextra" flags to extra compiler flags for gcc. 2.4
mus 02/20/17 Updated tcl to guard xparameters.h by protection macros 2.5 ms
04/18/17 Modified tcl file to add suffix U for XPAR_CPU_ID parameter of
cpu_cortexa9 in xparameters.h 2.6 mus 02/20/18 Updated tcl to add "-g" flag in
extra compiler flags, for linaro toolchain. It fixes CR995214 2.7 mus 07/03/18
Updated tcl to not to add default flags forcefully into extra compiler flags.
Now, user can remove default flags from extra compiler flags. It fixes CR998768.
2.8 aru 04/18/19 Updated tcl to add assembler for ARMCC and IAR uses
"xillib.tcl" "generate" procedure

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexa9/data/cpu_cortexa9.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcpu_cortexa9.h @addtogroup
cpu_cortexa9_v2_7 @{ @details dummy file MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 2.5 ms 04/18/17 Modified tcl file to add suffix U
for XPAR_CPU_ID parameter of cpu_cortexa9 in xparameters.h 2.7 mus 07/03/18
Updated tcl to not to add default flags forcefully into extra compiler flags.
Now, user can remove default flags from extra compiler flags. It fixes CR998768.
@} /

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexa9/src/xcpu_cortexa9.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 pkp 07/21/14 Initial common::version 1.2 mus
02/20/17 Updated tcl to guard xparameters.h by protection macros 1.4 ms 04/18/17
Modified tcl file to add suffix U for XPAR_CPU_ID parameter of cpu_cortexr5 in
xparameters.h 1.4 srm 02/21/18 Updated freertos to 10.0 1.5 asa 03/01/19 Updated
to add hard float support for R5 FreeRTOS BSP. 1.5 mus 03/19/19 Updated to add
hard float support for IAR R5 BSP. 1.6 aru 04/18/19 Updated tcl to add assembler
for ARMCC and IAR uses "xillib.tcl" "generate" procedure

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexr5/data/cpu_cortexr5.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcpu_cortexr5.h @addtogroup
cpu_cortexr5_v1_5 @{ @details dummy file MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.4 ms 04/18/17 Modified tcl file to add suffix U
for XPAR_CPU_ID parameter of cpu_cortexr5 in xparameters.h 1.5 asa 03/01/19
Updated to add had float support for R5 freertos bsp. @} /

FILES:
XilinxProcessorIPLib/drivers/cpu_cortexr5/src/xcpu_cortexr5.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ----- ---------- 4.0 adk 03/12/14 FirstRelease 4.1 ms 01/16/17
Updated the parameter naming from XPAR_CRESAMPLE_NUM_INSTANCES to
XPAR_XCRESAMPLE_NUM_INSTANCES to avoid compilation failure for
XPAR_CRESAMPLE_NUM_INSTANCES as the tools are generating
XPAR_XCRESAMPLE_NUM_INSTANCES in the generated xcresample_g.c for fixing MISRA-C
files. This is a fix for CR-966099 based on the update in the tools.

FILES:
XilinxProcessorIPLib/drivers/cresample/data/cresample.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file cresample_conversion_example.c
This file contains an example how CRESAMPLE type conversions will be done on the
device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------
-------- 4.0 adk 03/12/14 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cresample/examples/cresample_conversion_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file cresample_selftest_example.c
This file contains an example using the XCRESAMPLE driver to do self test on the
device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------
-------- 4.0 adk 03/12/14 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cresample/examples/cresample_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcresample.c @addtogroup
cresample_v4_1 @{ This file contains the implementation of the interface
functions for the Chroma Resampler core. Refer to the header file xcresample.h
for more detailed information. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00a gaborz 08/04/11 Updated for CRESAMPLE V1.0 2.00a vyc
04/24/12 Updated for CRESAMPLE V2.00.a 2.00a vyc 07/25/12 Switched from Xuu3232
to u32 2.00a vyc 10/16/12 Switch order of functions to remove compile warning
4.0 adk 03/12/14 Changed the filename cresample.c to xcresample.c. The Following
functions are removed: clear_coef_values, configure_444_to_422,
configure_422_to_444, configure_422_to_420, configure_420_to_422,
configure_444_to_420 and configure_420_to_444. Implemented the following
functions : StubCallBack, StubErrorCallBack, XCresample_CfgInitialize,
XCresample_GetVersion, XCresample_EnableDbgByPass,
XCresample_IsDbgByPassEnabled, XCresample_DisableDbgByPass,
XCresample_SetDbgTestPattern, XCresample_IsDbgTestPatternEnabled,
XCresample_DisableDbgTestPattern XCresample_GetDbgFrameCount,
XCresample_GetDbgLineCount, XCresample_GetDbgPixelCount,
XCresample_SetActiveSize, XCresample_GetActiveSize, XCresample_SetFieldParity,
XCresample_GetFieldParity, XCresample_SetChromaParity,
XCresample_GetChromaParity XCresample_SetHCoefs, XCresample_GetHCoefs,
XCresample_SetVCoefs, XCresample_GetVCoefs, XCresample_Clear_HCoef_Values, and
XCresample_Clear_VCoef_Values. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cresample/src/xcresample.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcresample.h @addtogroup
cresample_v4_1 @{ @details This header file contains identifiers and register-
level driver functions (or macros), that can be used to access the Xilinx Chroma
Resampler (Cresample) core instance. The Chroma Resampler core converts between
chroma sub-sampling formats of 4:4:4, 4:2:2,and 4:2:0. There are a total of six
conversions available for the three supported sub-sampling formats. Conversion
is achieved using a FIR filter approach. Some conversions require filtering in
only the horizontal dimension, only the vertical dimension, or both.
Interpolation operations are implemented using a two-phase polyphase FIR filter.
Decimation operations are implemented using a low-pass FIR filter to suppress
chroma aliasing. Features of Chroma Resampler core are - Configurable filters
sizes with programmable filter coefficients for high performance applications. -
Replicate or drop pixels. - Static, predefined, powers-of-two coefficients for
low-footprint applications - Converts between YCbCr: 4:4:4, 4:2:2,and 4:2:0. -
Supports both progressive and interlaced video. <b>Initialization &
Configuration</b> The device driver enables higher layer software (e.g., an
application) to communicate to the Cresample core. XCresample_CfgInitialize()
API is used to initialize the Cresample core. The user needs to first call the
XCresample_LookupConfig() API which returns the Configuration structure pointer
which is passed as a parameter to the XCresample_CfgInitialize() API. <b>
Interrupts </b> The driver provides an interrupt handler XCresample_IntrHandler
for handling the interrupt from the Cresample core. The users of this driver
have to register this handler with the interrupt system and provide the callback
functions by using XCresample_SetCallBack API. <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b> Building the driver </b> The Cresample
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------- -------- 2.00a vy 04/24/12 Updated
for version 2.00.a Converted from xio.h to xil_io.h, translating basic type, MB
cache functions, exceptions and assertion to xil_io format. 1.00a vy 10/22/10
Initial version 3.0 adk 19/12/13 Updated as per the New Tcl API's. 4.0 adk
03/12/14 Changed the file name cresample.h to xcresample.h. Macros of register
offsets, bit definitions, ReadReg and WriteReg macros which are the part of
xcresample_hw.h.were moved to xcresample_hw.h. Removed file inclusion of
Xil_io.h. Removed the following functional macros: CRESAMPLE_Enable,
CRESAMPLE_Disable, CRESAMPLE_RegUpdateEnable, CRESAMPLE_RegUpdateDisable,
CRESAMPLE_Reset, CRESAMPLE_ClearReset, CRESAMPLe_AutoSyncReset. Defined the
following functional macros: XCresample_Enable, XCresample_Disable,
XCresample_RegUpdateEnable,XCresample_RegUpdateDisable XCresample_Reset,
XCresample_ClearReset, XCresample_SyncReset, XCresample_IntrDisable,
XCresample_IntrEnable, XCresample_StatusGetPending XCresample_IntrGetPending,
XCresample_IntrClear. Declared following structures: XCresample_Config and
XCresample of Chroma Resampler. Defined the following range macros:
XCRE_VSIZE_FIRST, XCRE_VSIZE_LAST, XCRE_HSIZE_FIRST, XCRE_HSIZE_FIRST,
XCRE_HSIZE_LAST, XCRE_PARITY_ODD, XCRE_PARITY_EVEN, XCRE_COEF_FIRST,
XCRE_COEF_LAST, XCRE_OFFSET_DIFF, XCRE_NUM_OF_PHASES, XCRE_NUM_HCOEFS, and
XCRE_NUM_VCOEFS. Modifications in the file xcresample_hw.h are: Added the
register offsets and bit masks for the registers and added backward
compatibility for macros. Modifications in the file xcresample.c are: Changed
the filename cresample.c to xcresample.c. The Following functions are removed:
clear_coef_values, configure_444_to_422, configure_422_to_444,
configure_422_to_420, configure_420_to_422, configure_444_to_420 and
configure_420_to_444. Implemented the following functions : StubCallBack,
StubErrorCallBack, XCresample_CfgInitialize, XCresample_GetVersion,
XCresample_EnableDbgByPass, XCresample_IsDbgByPassEnabled,
XCresample_DisableDbgByPass, XCresample_SetDbgTestPattern,
XCresample_IsDbgTestPatternEnabled, XCresample_DisableDbgTestPattern
XCresample_GetDbgFrameCount, XCresample_GetDbgLineCount,
XCresample_GetDbgPixelCount, XCresample_SetActiveSize, XCresample_GetActiveSize,
XCresample_SetFieldParity, XCresample_GetFieldParity,
XCresample_SetChromaParity, XCresample_GetChromaParity XCresample_SetHCoefs,
XCresample_GetHCoefs, XCresample_SetVCoefs, XCresample_GetVCoefs,
XCresample_Clear_HCoef_Values, and XCresample_Clear_VCoef_Values. Modifications
in the file xcresample_intr.c are: Implemented XCresample_IntrHandler and
XCresample_SetCallBack functions. Modifications in the file
xcresample_selftest.c are: Implemented XCresample_SelfTest function.
Modifications in the file xcresample_sinit.c are: Implemented
XCresample_LookupConfig function. 4.1 ms 01/16/17 Updated the parameter naming
from XPAR_CRESAMPLE_NUM_INSTANCES to XPAR_XCRESAMPLE_NUM_INSTANCES to avoid
compilation failure for XPAR_CRESAMPLE_NUM_INSTANCES as the tools are generating
XPAR_XCRESAMPLE_NUM_INSTANCES in the generated xcresample_g.c for fixing MISRA-C
files. This is a fix for CR-966099 based on the update in the tools. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/cresample/src/xcresample.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcresample_hw.h @addtogroup
cresample_v4_1 @{ This header file contains identifiers and register-level
driver functions (or macros) that can be used to access the Xilinx Chroma
Resampler core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------
-------- 4.0 adk 03/12/14 First release Added the register offsets and bit masks
for the registers and added backward compatibility for macros. </pre>

FILES:
XilinxProcessorIPLib/drivers/cresample/src/xcresample_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcresample_intr.c @addtogroup
cresample_v4_1 @{ This file contains interrupt related functions of Chroma
Resampler core Please see xcresample.h for more details of the core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 4.0 adk
03/12/14 First Release. Implemented XCresample_IntrHandler and
XCresample_SetCallBack functions. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cresample/src/xcresample_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcresample_selftest.c
@addtogroup cresample_v4_1 @{ This file contains the self-test functions for the
Chroma Resampler core. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 4.0 adk 03/12/14 First release Implemented XCresample_SelfTest
function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/cresample/src/xcresample_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcresample_sinit.c @addtogroup
cresample_v4_1 @{ This file contains initialization methods for Xilinx Chroma
Resampler core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------
-------- 4.0 adk 03/12/14 First release. Implemented XCresample_LookupConfig
function. 4.1 ms 01/16/17 Updated the parameter naming from
XPAR_CRESAMPLE_NUM_INSTANCES to XPAR_XCRESAMPLE_NUM_INSTANCES to avoid
compilation failure for XPAR_CRESAMPLE_NUM_INSTANCES as the tools are generating
XPAR_XCRESAMPLE_NUM_INSTANCES in the generated xcresample_g.c for fixing MISRA-C
files. This is a fix for CR-966099 based on the update in the tools. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/cresample/src/xcresample_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- -------- 1.0 vsa 07/21/15 Initial version uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/csi/data/csi.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi_example_selftest.c This
file contains an example using the XCsi driver to do self test on the device.
@note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------
-------- 1.1 ms 01/23/17 Modified xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation of
examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi/examples/xcsi_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi.c @addtogroup csi_v1_1 @{
This file implements the functions to control and get info from the CSI2 RX
Controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------
1.0 vsa 06/17/15 Initial release 1.1 sss 08/17/16 Added 64 bit support </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi/src/xcsi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi.h @addtogroup csi_v1_1 @{
@details This file contains the implementation of the MIPI CSI2 RX Controller
driver. User documentation for the driver functions is contained in this file in
the form of comment blocks at the front of each function. <b>Core Features</b>
The CSI2 Rx Controller currently supports the MIPI?Alliance Specification for
Camera Serial Interface 2 (CSI-2) Version 1.1 ? 18 July 2012 with D-PHY v1.2.
There is a provision for multi-lane support for upto 4 lanes for receiving data
upto 1.5 Gbps per lane. It supports both short and long packets. Most of the
primary and secondary formats of images are supported along with interleaving of
data at packet or frame level for upto 4 virtual channels in the stream. The IP
has capability to detect Start of Transmission, CRC, ECC, etc type of errors and
report them via interrupts. The IP is programmable when the core is disabled or
when the soft reset bit has been set and the reset-in-progress is reset. The
programmable parameters are the number of active lane counts, global interrupt
enable and interrupt masks for variety of events to be detected. <b>Software
Initialization & Configuration</b> The application needs to do following steps
in order for preparing the MIPI CSI2 Rx core to be ready to receive stream -
Call XCsi_LookupConfig using a device ID to find the core configuration. - Call
XCsi_CfgInitialize to initialize the device and the driver instance associated
with it. - Call XCsi_Configure to set the Active Lanes - Register callback
functions for interrupts - Enable interrupts - Call XCsi_Activate to activate
the core <b> Interrupts </b> There are certain events for which interrupts are
received if unmasked like - Frame received - Incorrect Lane Configuration -
Short Packet FIFO Full or Not Empty - Stream Line Buffer Full - Stop State -
Start of Transmission (Sync) Errors - CRC and ECC errors - Invalid Data ID -
Frame Sync and Level Errors for Virtual Channels <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that
application developers leave asserts on during development. <pre> MODIFICATION
HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa 06/16/15 Initial release
1.1 sss 08/17/16 Added 64 bit support ms 01/23/17 Modified xil_printf statement
in main function for all examples to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. ms 04/05/17
Modified Comment lines in functions of csi examples to recognize it as
documentation block for doxygen generation of examples. </pre>

FILES:
XilinxProcessorIPLib/drivers/csi/src/xcsi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi_hw.h @addtogroup csi_v1_1
@{ Hardware register & masks definition file. It defines the register interface.
<pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa
06/15/15 Initial release 1.1 sss 08/17/16 Added 64 bit support 1.2 vsa 03/02/17
Add Word Count corruption interrupt bit support </pre>

FILES:
XilinxProcessorIPLib/drivers/csi/src/xcsi_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi_intr.c @addtogroup
csi_v1_1 @{ This file implements the functions which handle the interrupts and
callbacks in the CSI2 Rx Controller. The callbacks are registered for events
which are interrupts clubbed together on the basis of the CSI specification.
<pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa
07/28/15 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi/src/xcsi_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi_selftest.c @addtogroup
csi_v1_1 @{ Contains diagnostic/self-test functions for the CSI Rx Controller
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa
06/18/15 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi/src/xcsi_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi_sinit.c @addtogroup
csi_v1_1 @{ Look up the hardware settings using device ID. The hardware setting
is inside the configuration table in xcsi_g.c, generated automatically by XPS or
manually by the user. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
-------- 1.0 vsa 06/18/15 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi/src/xcsi_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- -------- 1.0 sss 07/21/16 Initial version 1.1 vsa 02/28/18 Added
Frame Generation feature uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/csi2tx/data/csi2tx.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2tx_example_selftest.c
@addtogroup csi2tx_v1_0 @{ This file contains a design example using the
XCsi2TxSs driver. It performs a self test on the MIPI CSI2 Tx driver that will
test its sub-cores self test functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes --- --- -------- 1.0 sss 08/02/16 Initial release ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation of examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2tx/examples/xcsi2tx_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2tx.c @addtogroup
csi2tx_v1_0 @{ This file implements the functions to control and get info from
the CSI2 TX Controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
-------- 1.0 sss 07/15/16 Initial release 1.1 vsa 02/28/18 Added Frame End
Generation feature </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2tx/src/xcsi2tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2tx.h @addtogroup
csi2tx_v1_0 @{ @details This file contains the implementation of the MIPI CSI2
TX Controller driver. User documentation for the driver functions is contained
in this file in the form of comment blocks at the front of each function.
<b>MIPI CSI2 Tx Overview</b> CSI-2 Tx Controller receives stream of image data
via Native / AXI4 Stream input interface. It Packs the incoming image data into
CSI-2 Packet Structure i.e Packs the Synchronization pacckets & performs the
pixel-2-Byte Conversions for the pixel Data.Packed Byte data is sent over the
D-PHY Interface for transmission. AXI4-Lite interface will be used to access
core registers. CSI2-Tx Controller support’s ECC & CRC generation for header &
payload respectively. <b>Core Features</b> The Xilinx CSI-2 Tx has the following
features: • Compliant with the MIPI CSI-2 Interface Specification, rev. 1.1
• Standard PPI interface i.e. D-PHY • 1-4 Lane Support,configurable through
GUI • Maximum Data Rate per – 1.5 Gigabits per second • Multiple data type
support : • RAW8,RAW10,RAW12,RAW14,RGB888,YUV422-8Bit,User defined Data types
• Supports Single,Dual,Quad Pixel Modes, configurable through GUI • Virtual
channel Support (1 to 4) • Low Power State(LPS) insertion between the packets.
• Ultra Low Power(ULP) mode generation using register access. • Interrupt
generation & Core Status information can be accessed through Register Interface
• Multilane interoperability. • ECC generation for packet header. • CRC
generation for data bytes(Can be Enabled / Disabled), configurable through GUI.
• Pixel byte conversion based on data format. • AXI4-Lite interface to
access core registers. • Compliant with Xilinx AXI Stream Interface & native
Interface for input video stream. • LS/LE Packet Generation,can be configured
through register interface. • Configurable selection of D-PHY Register
Interface through GUI options. • Support for transmission of Embedded Data
packet’s through Input Interface. <b>Interrupts</b> The XCsi2Tx_SetCallBack()
is used to register the call back functions for MIPI CSI2 Tx driver with the
corresponding handles <b> Virtual Memory </b> This driver supports Virtual
Memory. The RTOS is responsible for calculating the correct device base address
in Virtual Memory space. <b> Threads </b> This driver is not thread safe. Any
needs for threads or thread mutual exclusion must be satisfied by the layer
above this driver. <b> Asserts </b> Asserts are used within all Xilinx drivers
to enforce constraints on argument values. Asserts can be turned off on a
system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that application developers
leave asserts on during development. <pre> MODIFICATION HISTORY: Ver Who Date
Changes --- --- -------- 1.0 sss 07/15/16 Initial release ms 01/23/17 Modified
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. ms 04/05/17 Modified Comment lines in functions of csi2tx
examples to recognize it as documentation block for doxygen generation of
examples. vsa 15/12/17 Add support for Clock Mode 1.1 vsa 02/28/18 Added Frame
End Generation feature </pre>

FILES:
XilinxProcessorIPLib/drivers/csi2tx/src/xcsi2tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2tx_hw.h @addtogroup
csi2tx_v1_0 @{ Hardware register & masks definition file. It defines the
register interface. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
-------- 1.0 sss 07/15/16 Initial release vsa 05/12/17 Add support for Clock
Mode 1.1 vsa 02/28/18 Added Frame End Generation feature </pre>

FILES:
XilinxProcessorIPLib/drivers/csi2tx/src/xcsi2tx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2tx_intr.c @addtogroup
csi2tx_v1_0 @{ This file implements the functions which handle the interrupts
and callbacks in the CSI2 Tx Controller. The callbacks are registered for events
which are interrupts clubbed together on the basis of the CSI specification.
<pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 sss
07/28/16 Initial release 1.1 vsa 02/28/18 Added Frame End Generation feature
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2tx/src/xcsi2tx_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2tx_selftest.c @addtogroup
csi2tx_v1_0 @{ Contains diagnostic/self-test functions for the CSI Tx Controller
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 sss
07/28/16 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2tx/src/xcsi2tx_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2tx_sinit.c @addtogroup
csi2tx_v1_0 @{ Look up the hardware settings using device ID. The hardware
setting is inside the configuration table in xcsi2tx_g.c, generated
automatically by XPS or manually by the user. <pre> MODIFICATION HISTORY: Ver
Who Date Changes --- --- -------- 1.0 sss 07/28/16 Initial release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2tx/src/xcsi2tx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- -------- 1.0 sss 07/21/16 Initial version of subsystem tcl 1.1
vsa 08/31/17 Fix for IP with different name 1.2 vsa 02/28/18 Add Frame End
Generation Feature

FILES:
XilinxProcessorIPLib/drivers/csi2txss/data/csi2txss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss_intr_example.c
@addtogroup csi2txss_v1_0 @{ This file contains a design example using XCsi2TxSs
driver with interrupts. It notify which of the following interrupt is generated
by a print message - Incorrect Lane Configuration - GSP FIFO Full - Ulps State -
Line Buffer Full - Unsupported/Reserved Data type - Pixel Data underrun @note
This example requires an interrupt controller connected to the processor and the
MIPI CSI2Tx Subsystem in the system. For this example to display output, the
user need to implement initialization of the system (Csi2TxSs_PlatformInit) and
after MIPI CSI2Tx subsystem start (XCsi2TxSs_Start) is complete, implement
configuration of the video stream source in order to provide the MIPI CSI2Tx
Subsystem HIP input. The functions Csi2TxSs_PlatformInit and Csi2TxSs_StreamSrc
are declared and are left up to the user implement. <pre> MODIFICATION HISTORY:
Ver Who Date Changes --- --- -------- 1.0 sss 08/02/16 Initial release ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2txss/examples/xcsi2txss_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss_selftest_example.c
@addtogroup csi2txss_v1_0 @{ This file contains a design example using the
XCsi2TxSs driver. It performs a self test on the MIPI CSI2 Tx Subsystem that
will test its sub-cores self test functions. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes --- --- -------- 1.0 sss 07/14/16 Initial release
ms 01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2txss/examples/xcsi2txss_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss.c @addtogroup
csi2txss_v1_1 @{ This is main code of Xilinx MIPI CSI Tx Subsystem device
driver. Please see xcsi2txss.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 sss 07/14/16
Initial release vsa 15/12/17 Add support for Clock Mode 1.2 vsa 02/28/18 Add
Frame End Generation feature </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2txss/src/xcsi2txss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss.h @addtogroup
csi2txss_v1_1 @{ @details This is main header file of the Xilinx MIPI CSI Tx
Subsystem driver. <b>MIPI CSI2 Tx Subsystem Overview</b> CSI-2 Tx Controller
receives stream of image data via Native / AXI4 Stream input interface. It
Packs the incoming image data into CSI-2 Packet Structure i.e Packs the
Synchronization pacckets & performs the pixel-2-Byte Conversions for the pixel
Data.Packed Byte data is sent over the D-PHY Interface for transmission.
AXI4-Lite interface will be used to access core registers. CSI2-Tx Controller
support’s ECC & CRC generation for header & payload respectively. <b>Core
Features</b> The Xilinx CSI-2 Tx Subsystem has the following features: •
Compliant with the MIPI CSI-2 Interface Specification, rev. 1.1 • Standard PPI
interface i.e. D-PHY • 1-4 Lane Support,configurable through GUI • Maximum
Data Rate per – 1.5 Gigabits per second • Multiple data type support : o
RAW8,RAW10,RAW12,RAW14,RGB888,YUV422-8Bit,User defined Data types • Supports
Single,Dual,Quad Pixel Modes, configurable through GUI • Virtual channel
Support (1 to 4) • Low Power State(LPS) insertion between the packets. •
Ultra Low Power(ULP) mode generation using register access. • Interrupt
generation & Core Status information can be accessed through Register Interface
• Multilane interoperability. • ECC generation for packet header. • CRC
generation for data bytes(Can be Enabled / Disabled), configurable through GUI.
• Pixel byte conversion based on data format. • AXI4-Lite interface to
access core registers. • Compliant with Xilinx AXI Stream Interface & native
Interface for input video stream. • LS/LE Packet Generation,can be configured
through register interface. • Configurable selection of D-PHY Register
Interface through GUI options. • Support for transmission of Embedded Data
packet’s through Input Interface. <b>Software Initialization &
Configuration</b> The application needs to do following steps in order for
preparing the MIPI CSI2 Tx Subsystem core to be ready. - Call
XCsi2TxSs_LookupConfig using a device ID to find the core configuration. - Call
XCsi2TxSs_CfgInitialize to initialize the device and the driver instance
associated with it. <b>Interrupts</b> The XCsi2TxSs_SetCallBack() is used to
register the call back functions for MIPI CSI2 Tx Subsystem driver with the
corresponding handles <b> Virtual Memory </b> This driver supports Virtual
Memory. The RTOS is responsible for calculating the correct device base address
in Virtual Memory space. <b> Threads </b> This driver is not thread safe. Any
needs for threads or thread mutual exclusion must be satisfied by the layer
above this driver. <b>Asserts</b> Asserts are used within all Xilinx drivers to
enforce constraints on argument values. Asserts can be turned off on a system-
wide basis by defining, at compile time, the NDEBUG identifier. By default,
asserts are turned on and it is recommended that application developers leave
asserts on during development. <b>Building the driver</b> The MIPI CSI2 Tx
Subsystem driver is composed of source files and depends on the CSI and DPHY
drivers. The DPHY driver is pulled in only if the register interface has been
enabled for it.Otherwise the CSI2TX driver and subsystem files are built. <pre>
MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 sss 07/14/16
Initial release ms 01/23/17 Modified xil_printf statement in main function for
all examples to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. vsa 15/12/17 Add
support for Clock Mode 1.2 vsa 02/28/18 Add Frame End Generation feature </pre>

FILES:
XilinxProcessorIPLib/drivers/csi2txss/src/xcsi2txss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss_hw.h @addtogroup
csi2txss_v1_1 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx MIPI CSI2 Tx
Subsystem core. For more information about the operation of this core see the
hardware specification and documentation in the higher level driver xcsi2tx.h
file. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 sss
07/14/16 Initial release 1.2 vsa 02/28/18 Add Frame End Generation feature
</pre>

FILES:
XilinxProcessorIPLib/drivers/csi2txss/src/xcsi2txss_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss_intr.c @addtogroup
csi2txss_v1_1 @{ This is the interrupt handling part of the Xilinx MIPI CSI2 Tx
Subsystem device driver. The interrupt registration and handler are defined
here. The callbacks are registered for events which are interrupts clubbed
together on the basis of the CSI2 specification. Refer to CSI2 driver for the
event groups. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------
1.0 sss 08/03/16 Initial release 1.2 vsa 02/28/18 Add Frame End Generation
feature </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2txss/src/xcsi2txss_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss_selftest.c
@addtogroup csi2txss_v1_1 @{ This file contains self test function for the MIPI
CSI Rx Subsystem <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
-------- 1.0 sss 07/14/16 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2txss/src/xcsi2txss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsi2txss_sinit.c @addtogroup
csi2txss_v1_1 @{ This file contains the implementation of the MIPI CSI Rx
Subsystem driver's static initialization functionality. <pre> MODIFICATION
HISTORY: Ver Who Date Changes --- --- -------- 1.0 sss 07/21/16 Initial release
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csi2txss/src/xcsi2txss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 vnsld 22/10/14 First release 1.4 adk 09/19/18
Use -hier option while using get_cells command to support hierarchical designs.
uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/csudma/data/csudma.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes -------- ------ -------- 1.2 adk 11/22/17 Added peripheral test app
support. Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj):
0 : MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/csudma/data/csudma_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma_intr_example.c This
file contains a design example using the XCsuDma driver in interrupt mode. It
sends data and expects to receive the same data through the device using the
local loop back mode. @note The example contains an infinite loop such that if
interrupts are not working it may hang. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 vnsld 22/10/14 First release 1.2 adk 11/22/17
Added peripheral test app support. 1.4 adk 04/12/17 Added support for PMC DMA.
adk 11/01/18 Declared static array rather than hard code memory for buffers. adk
18/01/18 Remove unnecessary column in XIntc_Connect() API. 1.5 adk 09/05/19
Added volatile keyword for DstDone variable to disable optimizations. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/csudma/examples/xcsudma_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma_polled_example.c This
file contains an example using the XCsuDma driver in polled mode. This function
works in loop back mode and tests whether transfer of data is completed properly
or not. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 vnsld 22/10/14 First release 1.4 adk 04/12/17 Added support for PMC DMA.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csudma/examples/xcsudma_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma_selftest_example.c This
file contains an example using the XCsudma driver to do self test on the device.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vnsld
22/10/14 First release ms 04/10/17 Modified filename tag to include the file in
doxygen examples. 1.2 adk 11/22/17 Added peripheral test app support. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/csudma/examples/xcsudma_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma.c @addtogroup
csudma_v1_5 @{ This file contains the implementation of the interface functions
for CSU_DMA driver. Refer to the header file xcsudma.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 vnsld 22/10/14 First release 1.1 adk 10/05/16 Fixed CR951040 race
condition in the recv path when source and destination points to the same
buffer. 1.4 Nava 1/10/19 Added PSU_PMU processor check to skip the Flushing
cache memory and Invalidating cache memory API's for PMU Microblaze platform.
Rama 02/26/19 Fixed IAR issue by changing "XCsuDma_WaitForDoneTimeout" to
function arc 03/26/19 Fixed MISRA-C violations. 1.5 aru 07/05/19 Fixed coverity
warning. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csudma/src/xcsudma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. The CSU_DMA is present inside CSU
(Configuration Security Unit) module which is located within the Low-Power
Subsystem (LPS) internal to the PS. CSU_DMA allows the CSU to move data
efficiently between the memory (32 bit AXI interface) and the CSU stream
peripherals (SHA, AES and PCAP) via Secure Stream Switch (SSS). The CSU_DMA is a
2 channel simple DMA, allowing separate control of the SRC (read) channel and
DST (write) channel. The DMA is effectively able to transfer data: - From PS-
side to the SSS-side (SRC DMA only) - From SSS-side to the PS-side (DST DMA
only) - Simultaneous PS-side to SSS_side and SSS-side to the PS-side
<b>Initialization & Configuration</b> The device driver enables higher layer
software (e.g., an application) to communicate to the CSU_DMA core.
XCsuDma_CfgInitialize() API is used to initialize the CSU_DMA core. The user
needs to first call the XCsuDma_LookupConfig() API which returns the
Configuration structure pointer which is passed as a parameter to the
XCsuDma_CfgInitialize() API. <b> Reset </b> This driver will not support
handling of CRP PDMA Reset in case of PMCDMA inorder to support multiple level
of handoff's. User needs to call the XCsuDma_PmcReset() API before performing
any driver operation to make sure PMCDMA is in proper state. <b> Interrupts </b>
This driver will not support handling of interrupts user should write handler to
handle the interrupts. <b> Virtual Memory </b> This driver supports Virtual
Memory. The RTOS is responsible for calculating the correct device base address
in Virtual Memory space. <b> Threads </b> This driver is not thread safe. Any
needs for threads or thread mutual exclusion must be satisfied by the layer
above this driver. <b> Asserts </b> Asserts are used within all Xilinx drivers
to enforce constraints on argument values. Asserts can be turned off on a
system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The XCsuDma driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. @file xcsudma.h @addtogroup csudma_v1_5 @{
@details This header file contains identifiers and register-level driver
functions (or macros), range macros, structure typedefs that can be used to
access the Xilinx CSU_DMA core instance. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.0 vnsld 22/10/14 First release 1.1 adk
10/05/16 Fixed CR951040 race condition in the recv path when source and
destination points to the same buffer. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/10/17 Modified filename tag in
xcsudma_selftest_example.c to include the file in doxygen examples. 1.2 adk
11/22/17 Added peripheral test app support for CSUDMA driver. 1.4 adk 04/12/17
Added support for PMC DMA. adk 09/03/18 Added new API XCsuDma_64BitTransfer()
useful for 64-bit dma transfers through PMU processor(CR996201). adk 25/06/18
Move CRP and PMC Global address defines to xparameters_ps.h file(CR1002035). adk
08/08/18 Added new API XCsuDma_WaitForDoneTimeout() useful for polling dma
transfer done. adk 28/08/18 Fixed misra-c required standard violations.. Rama
02/26/19 Fixed IAR issue by changing "XCsuDma_WaitForDoneTimeout" to function
arc 03/26/19 Fixed MISRA-C violations. </pre>

FILES:
XilinxProcessorIPLib/drivers/csudma/src/xcsudma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma_hw.h @addtogroup
csudma_v1_5 @{ This header file contains identifiers and register-level driver
functions (or macros) that can be used to access the Xilinx CSU_DMA core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vnsld
22/10/14 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/csudma/src/xcsudma_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma_intr.c @addtogroup
csudma_v1_5 @{ This file contains interrupt related functions of Xilinx CSU_DMA
core. Please see xcsudma.h for more details of the driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vnsld 22/10/14 First
release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csudma/src/xcsudma_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma_selftest.c @addtogroup
csudma_v1_5 @{ This file contains a diagnostic self-test function for the
CSU_DMA driver. Refer to the header file xcsudma.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 vnsld 22/10/14 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csudma/src/xcsudma_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsudma_sinit.c @addtogroup
csudma_v1_5 @{ This file contains static initialization methods for Xilinx
CSU_DMA core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 vnsld 22/10/14 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/csudma/src/xcsudma_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xddcrpsu.h @addtogroup
ddrcpsu_v1_1 @{ @details The Xilinx DdrcPsu driver. This driver supports the
Xilinx ddrcpsu IP core. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 ssc 04/28/16 First Release. 1.1 adk 04/08/16
Export DDR freq to xparameters.h file. </pre>

FILES:
XilinxProcessorIPLib/drivers/ddrcpsu/src/xddrcpsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xddrps.h @addtogroup ddrps_v1_0
@{ @details The Xilinx DdrPs driver. This driver supports the Xilinx ddrps IP
core. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 nsk 08/06/15 First Release 1.0 nsk 08/20/15 Updated
define_addr_params in ddrps.tcl to support PBD Designs (CR 876857) </pre>

FILES:
XilinxProcessorIPLib/drivers/ddrps/src/xddrps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xddrpsv.h @addtogroup
ddrpsv_v1_0 @{ @details The Xilinx DdrPsv driver. This driver supports the
Xilinx axi_noc IP core. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 mus 03/16/19 First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/ddrpsv/src/xddrpsv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file deint_selftest_example.c This
file contains an example using the XDeint driver to do self test on the device.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 1.00a
drg/jz 01/13/10 First Release 1.03a sg 08/14/12 Updated the example for CR
666306. Modified the device ID to use the first Device Id Removed the printf at
the start of the main 3.2 adk 01/15/14 Modified function names as per guidelines
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/examples/deint_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdeint.c @addtogroup
deinterlacer_v3_2 @{ This is main code of Xilinx Vide Deinterlacer core. Please
see xdeint.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a rjh 07/10/11 First release 2.00a rjh
18/01/12 Updated for v_deinterlacer 2.00 3.2 adk 02/13/14 Changed the prototype
of XDeint_GetVersion Implemented the following functions: XDeint_GetFramestore
XDeint_GetVideo XDeint_GetThresholds XDeint_GetPulldown XDeint_GetSize </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdeint.h @addtogroup
deinterlacer_v3_2 @{ @details This is the main header file of Xilinx Video
Deinterlacer core. <b>Interrupt Service </b> The Deinterlacer can generate 11
interrupt sources - Internal Register update done - Deinterlacer is locked to
incoming video - Deinterlacer has lost lock to incoming video - Deinterlacer
internal FIFO error - Pull down activated - Pull down cancelled - Frame Tick -
Frame store Write setup error - Frame store Write FIFO overflow - Frame store
Read Field under run - Frame store Read Frame under run This driver provides
functions to install callbacks for the interrupts and enable/disable/clear any
of them. <b> Examples </b> Example(s) are provided with this driver to
demonstrate the self test. <b>Limitations</b> <b>BUS Interface</b> <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rjh
07/10/11 First release 2.00a rjh 18/01/12 Updated for v_deinterlacer 2.00 3.0
adk 19/12/13 Updated as per the New Tcl API's. 3.2 adk 02/13/14 Modified
XDeint_IntrDisable macro replace ISR_OFFSET with IER OFFSET, XDeint_InReset.
Added Doxygen support, adherence to Xilinx coding standards. Modification
history of xdeint_sinit.c: Added Doxygen support, adherence to Xilinx coding
standards. Modification history of xdeint_selftest.c: Added the XDeint_Selftest
function. Modification history of xdeint_intr.c: Adherence to Xilinx coding,
Doxygen guidelines. Modification history of xdeint_i.h: Added Doxygen support.
Modification history of xdeint_hw.h: Suffixed "_OFFSET" to all register offset
macros. Added bit masks for the registers and added backward compatibility for
macros. Modification history of xdeint.c: Changed the prototype of
XDeint_GetVersion Implemented the following functions: XDeint_GetFramestore
XDeint_GetVideo XDeint_GetThresholds XDeint_GetPulldown XDeint_GetSize ms
03/17/17 Added readme.txt file in examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file XDeint_g.c @addtogroup
deinterlacer_v3_2 @{ This file contains a template for configuration table of
Xilinx Video Deinterlacer For a real hardware system, Xilinx Platform Studio
(XPS) will automatically generate a real configuration table to match the
configuration of the Deinterlacer devices. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00a rjh 07/10/11 First release 2.00a rjh
18/01/12 Updated for v_deinterlacer 2.00 3.2 adk 02/13/14 Adherence to Xilinx
coding, Doxygen guidelines. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdeint_hw.h @addtogroup
deinterlacer_v3_2 @{ This header file contains identifiers and register-level
driver functions (or macros) that can be used to access the Xilinx Video
Deinterlacer core. For more information about the operation of this core, see
the hardware specification and documentation in the higher level core xdeint.h
source code file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a rjh 07/10/11 First release. 2.00a rjh 18/01/12 Updated for
v_deinterlacer 2.00. 3.2 adk 02/13/14 Suffixed "_OFFSET" to all register offset
macros. Added bit masks for the registers and added backward compatibility for
macros. Swapped bit definitions of XDEINT_MODE_COLOUR_YUV and
XDEINT_MODE_COLOUR_RGB. Modified bit definitions of version register. </pre>

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdeint_i.h @addtogroup
deinterlacer_v3_2 @{ This code contains internal functions of the Xilinx Video
Deinterlacer core. The application should not need the functions in this code to
control the Video Deinterlacer core. Read xdeint.h for detailed information
about the core. <pre> Ver Who Date Changes ----- ---- -------- 1.00a rjh
07/10/11 First release. 2.00a rjh 18/01/12 Updated for v_deinterlacer 2.00. 3.2
adk 02/13/14 Added Doxygen support. </pre>

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdeint_intr.c @addtogroup
deinterlacer_v3_2 @{ This code contains interrupt related functions of Xilinx
Video Deinterlacer (DEINT) core. Please see xdeint.h for more details of the
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- --------
1.00a rjh 07/10/11 First release. 2.00a rjh 18/01/12 Updated for v_deinterlacer
2.00. 3.2 adk 02/13/14 Adherence to Xilinx coding, Doxygen guidelines. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdeint_selftest.c @addtogroup
deinterlacer_v3_2 @{ This file contains the self-test functions for the XCfa
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 3.2
adk 02/13/14 First Release. Added the XDeint_Selftest function. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdeint_sinit.c @addtogroup
deinterlacer_v3_2 @{ This file contains static initialization methods for Xilinx
Video Deinterlacer (DEINT) core driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.00a rjh 07/10/11 First release. 2.00a rjh
18/01/12 Updated for v_deinterlacer 2.00. 3.2 adk 02/13/14 Added Doxygen
support, adherence to Xilinx coding standards. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/deinterlacer/src/xdeint_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/22/11 Created 3.0 adk 10/12/13 Updated
as per the New Tcl API's 3.4 sk 11/09/15 Removed delete filename statement CR
784758. 3.5 ms 04/18/17 Modified tcl file to add suffix U for all macros
definitions of devcfg in xparameters.h uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/devcfg/data/devcfg.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Updated as per the New Tcl
API's Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0
: MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/devcfg/data/devcfg_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_interrupt_example.c
This file contains a interrupt mode design example for the Device Configuration
Interface. This example downloads a given bitstream to the FPGA fabric.
BIT_STREAM_LOCATION specifies the memory location of the bitstream.
BIT_STREAM_SIZE_WORDS specifies the size of the bitstream in words. User has to
define these correctly for this example to work. @note None MODIFICATION
HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.00a hvm 02/07/11 First
release 1.00a nm 11/26/11 Holding FPGA in reset before download and releasing it
after bitstream download. This code is not checking bitstream download errors.
If the bitstream download fails, this test hangs. 2.00a nm 05/31/12 Updated the
notes in the example for CR 660139 to add information that the 2 LSBs of the
Source/Destination address when equal to 2�b01 indicate the last DMA command
of an overall transfer. Updated the example for CR 660835 so that input length
for source/destination to the XDcfg_Transfer APIs is words (32 bit) and not
bytes. 2.01a nm 11/21/12 Fixed CR 688146. Modified the bitstream address. 2.02a
nm 01/31/13 Fixed CR 679335. Removed disabling and enabling AXI interface.
Clearing the interrupts before the transfer. Added support for partial
reconfiguration. 3.00a kpc 02/10/14 Fixed the compilation error 3.1 kpc 04/22/14
Fixed CR780203. Enable the pcap clock if it is not set. ms 04/10/17 Modified
filename tag to include the file in doxygen ms 04/10/17 Modified filename tag to
include the file in doxygen examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/examples/xdevcfg_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_polled_example.c This
file contains a polled mode design example for the Device Configuration
Interface. This example downloads a given bitstream to the FPGA fabric.
BIT_STREAM_LOCATION specifies the memory location of the bitstream.
BIT_STREAM_SIZE_WORDS specifies the size of the bitstream in words. User has to
define these correctly for this example to work. @note None. MODIFICATION
HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.00a hvm 11/19/10 First
release 1.00a nm 11/26/11 Holding FPGA in reset before download and releasing it
after bitstream download. This code is not checking bitstream download errors.
2.00a nm 05/31/12 Updated the notes in the example for CR 660139 to add
information that the 2 LSBs of the Source/Destination address when equal to
2�b01 indicate the last DMA command of an overall transfer. Updated the
example for CR 660835 so that input length for source/destination to the
XDcfg_Transfer APIs is words (32 bit) and not bytes. 2.01a nm 11/21/12 Fixed CR
688146. Modified the bitstream address. 2.02a nm 01/31/13 Fixed CR 679335.
Removed disabling and enabling AXI interface. Clearing the interrupts before the
transfer. Added support for partial reconfiguration. 3.00a kpc 02/20/14 Renamed
the DcfgInstance variable name to DcfgInstPtr 3.1 kpc 04/22/14 Fixed CR780203.
Enable the pcap clock if it is not set. ms 04/10/17 Modified filename tag to
include the file in doxygen examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/examples/xdevcfg_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_reg_readback_example.c
This file contains a design example using the DevCfg driver and hardware device.
This example prints out the values of all the configuration registers in the
FPGA. This example assumes that there is a UART Device or STDIO Device in the
hardware system. @note None. MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 3.1 sb 08/25/14 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/examples/xdevcfg_reg_readback_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_selftest_example.c This
file contains an self test example showing the usage of the Device Configuration
Interface Hardware and driver (XDevCfg). @note None <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 sdm 05/25/11 First release.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/examples/xdevcfg_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg.c @addtogroup
devcfg_v3_5 @{ This file contains the implementation of the interface functions
for XDcfg driver. Refer to the header file xdevcfg.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.00a hvm 02/07/11 First release 2.00a nm 05/31/12 Updated the driver for CR
660835 so that input length for source/destination to the XDcfg_InitiateDma,
XDcfg_Transfer APIs is words (32 bit) and not bytes. Updated the notes for
XDcfg_InitiateDma/XDcfg_Transfer APIs to add information that 2 LSBs of the
Source/Destination address when equal to 2�b01 indicate the last DMA command
of an overall transfer. Updated the XDcfg_Transfer function to use the
Destination Address passed to this API for secure transfers instead of using
0xFFFFFFFF for CR 662197. This issue was resulting in the failure of secure
transfers of non-bitstream images. 2.01a nm 08/27/12 Updated the XDcfg_Transfer
API to clear the QUARTER_PCAP_RATE_EN bit in the control register for non secure
writes for CR 675543. 2.02a nm 01/31/13 Fixed CR 679335. Added Setting and
Clearing the internal PCAP loopback. Removed code for enabling/disabling AES
engine as BootROM locks down this setting. Fixed CR 681976. Skip Checking the
PCFG_INIT in case of non-secure DMA loopback. Fixed CR 699558. XDcfg_Transfer
fails to transfer data in loopback mode. 2.03a nm 04/19/13 Fixed CR 703728.
Updated the register definitions as per the latest TRM version UG585 (v1.4)
November 16, 2012. 3.0 kpc 21/02/14 Implemented new function
XDcfg_ClearControlRegister 3.2 sb 08/25/14 Fixed XDcfg_PcapReadback() function
updated driver code with ! instead of , while checking for Interrupt Status with
DMA and PCAP Done Mask ((XDcfg_ReadReg(InstancePtr->Config.BaseAddr,
XDCFG_INT_STS_OFFSET) & XDCFG_IXR_D_P_DONE_MASK) ! XDCFG_IXR_D_P_DONE_MASK);
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg.h @addtogroup
devcfg_v3_5 @{ @details The is the main header file for the Device Configuration
Interface of the Zynq device. The device configuration interface has three main
functionality. 1. AXI-PCAP 2. Security Policy 3. XADC This current version of
the driver supports only the AXI-PCAP and Security Policy blocks. There is a
separate driver for XADC. AXI-PCAP is used for download/upload an encrypted or
decrypted bitstream. DMA embedded in the AXI PCAP provides the master interface
to the Device configuration block for any DMA transfers. The data transfer can
take place between the Tx/RxFIFOs of AXI-PCAP and memory (on chip
RAM/DDR/peripheral memory). The current driver only supports the downloading the
FPGA bitstream and readback of the decrypted image (sort of loopback). The
driver does not know what information needs to be written to the FPGA to
readback FPGA configuration register or memory data. The application above the
driver should take care of creating the data that needs to be downloaded to the
FPGA so that the bitstream can be readback. This driver also does not support
the reading of the internal registers of the PCAP. The driver has no knowledge
of the PCAP internals. <b> Initialization and Configuration </b> The device
driver enables higher layer software (e.g., an application) to communicate with
the Device Configuration device. XDcfg_CfgInitialize() API is used to initialize
the Device Configuration Interface. The user needs to first call the
XDcfg_LookupConfig() API which returns the Configuration structure pointer which
is passed as a parameter to the XDcfg_CfgInitialize() API. <b>Interrupts</b> The
Driver implements an interrupt handler to support the interrupts provided by
this interface. <b> Threads </b> This driver is not thread safe. Any needs for
threads or thread mutual exclusion must be satisfied by the layer above this
driver. <b> Asserts </b> Asserts are used within all Xilinx drivers to enforce
constraints on argument values. Asserts can be turned off on a system-wide basis
by defining, at compile time, the NDEBUG identifier. By default, asserts are
turned on and it is recommended that users leave asserts on during development.
<b> Building the driver </b> The XDcfg driver is composed of several source
files. This allows the user to build and link only those parts of the driver
that are necessary. <br><br> <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.00a hvm 02/07/11 First release 2.00a nm 05/31/12 Updated
the driver for CR 660835 so that input length for source/destination to the
XDcfg_InitiateDma, XDcfg_Transfer APIs is words (32 bit) and not bytes. Updated
the notes for XDcfg_InitiateDma/XDcfg_Transfer APIs to add information that 2
LSBs of the Source/Destination address when equal to 2�b01 indicate the last
DMA command of an overall transfer. Destination Address passed to this API for
secure transfers instead of using 0xFFFFFFFF for CR 662197. This issue was
resulting in the failure of secure transfers of non-bitstream images. 2.01a nm
07/07/12 Updated the XDcfg_IntrClear function to directly set the mask instead
of oring it with the value read from the interrupt status register Added defines
for the PS Version bits, removed the FIFO Flush bits from the Miscellaneous
Control Reg. Added XDcfg_GetPsVersion, XDcfg_SelectIcapInterface and
XDcfg_SelectPcapInterface APIs for CR 643295 The user has to call the
XDcfg_SelectIcapInterface API for the PL reconfiguration using AXI HwIcap.
Updated the XDcfg_Transfer API to clear the QUARTER_PCAP_RATE_EN bit in the
control register for non secure writes for CR 675543. 2.02a nm 01/31/13 Fixed CR
679335. Added Setting and Clearing the internal PCAP loopback. Removed code for
enabling/disabling AES engine as BootROM locks down this setting. Fixed CR
681976. Skip Checking the PCFG_INIT in case of non-secure DMA loopback. Fixed CR
699558. XDcfg_Transfer fails to transfer data in loopback mode. Fixed CR 701348.
Peripheral test fails with Running DcfgSelfTestExample() in SECURE bootmode.
2.03a nm 04/19/13 Fixed CR 703728. Updated the register definitions as per the
latest TRM version UG585 (v1.4) November 16, 2012. 3.0 adk 10/12/13 Updated as
per the New Tcl API's 3.0 kpc 21/02/14 Added function prototype for
XDcfg_ClearControlRegister 3.2 sb 08/25/14 Fixed XDcfg_PcapReadback() function
updated driver code with ! instead of , while checking for Interrupt Status with
DMA and PCAP Done Mask ((XDcfg_ReadReg(InstancePtr->Config.BaseAddr,
XDCFG_INT_STS_OFFSET) & XDCFG_IXR_D_P_DONE_MASK) ! XDCFG_IXR_D_P_DONE_MASK); A
new example has been added to read back the configuration registers from the PL
region. xdevcfg_reg_readback_example.c 3.3 sk 04/06/15 Modified
XDcfg_ReadMultiBootConfig Macro CR 851335. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/10/17 Modified filename tag in
interrupt and polled examples to include them in doxygen examples. 3.5 ms
04/18/17 Modified tcl file to add suffix U for all macros definitions of devcfg
in xparameters.h ms 08/07/17 Fixed compilation warnings in xdevcfg_sinit.c
</pre>

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_g.c @addtogroup
devcfg_v3_5 @{ This file contains a table that specifies the configuration of
the Device Configuration Interface device in the system. Each device should have
an entry in the table. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 1.00a hvm 02/07/11 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_hw.c @addtogroup
devcfg_v3_5 @{ This file contains the implementation of the interface reset
functionality <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 2.04a kpc 10/07/13 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_hw.h @addtogroup
devcfg_v3_3 @{ This file contains the hardware interface to the Device Config
Interface. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.00a hvm 02/07/11 First release 2.01a nm 08/01/12 Added defines for the PS
Version bits, removed the FIFO Flush bits from the Miscellaneous Control Reg
2.03a nm 04/19/13 Fixed CR 703728. Updated the register definitions as per the
latest TRM version UG585 (v1.4) November 16, 2012. 2.04a kpc 10/07/13 Added
function prototype. 3.00a kpc 25/02/14 Corrected the XDCFG_BASE_ADDRESS macro
value. </pre>

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_intr.c @addtogroup
devcfg_v3_5 @{ Contains the implementation of interrupt related functions of the
XDcfg driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a hvm 02/07/11 First release 2.01a nm 07/07/12 Updated the
XDcfg_IntrClear function to directly set the mask instead of oring it with the
value read from the interrupt status register </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_selftest.c @addtogroup
devcfg_v3_5 @{ Contains diagnostic self-test functions for the XDcfg driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a hvm
02/07/11 First release 2.02a nm 02/27/13 Fixed CR 701348. Peripheral test fails
with Running DcfgSelfTestExample() in SECURE bootmode. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdevcfg_sinit.c @addtogroup
devcfg_v3_5 @{ This file contains method for static initialization (compile-
time) of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a hvm 02/07/11 First release 3.5 ms 08/07/17 Fixed compilation
warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/devcfg/src/xdevcfg_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/22/11 Created 2.0 adk 10/12/13 Updated
as per the New Tcl API's uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/dmaps/data/dmaps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 2.0 adk 10/12/13 Updated as per the New Tcl API's
Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/dmaps/data/dmaps_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps_example_w_intr.c <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 hbm
08/19/2010 First Release 1.01a nm 03/05/2012 Initializing DmaCmd structure
compatible to armcc. Modified base address to secure register base address.
1.02a sg 05/16/2012 Some code cleanup and reorganisation of the functions within
the example. 1.06a kpc 04/24/2012 Modified the APIs to make this file compatible
with peripheral test suite. 2.1 kpc 08/23/2014 Fixed IAR compiler reported
error. 2.3 ms 01/23/17 Modified xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. </pre>

FILES:
XilinxProcessorIPLib/drivers/dmaps/examples/xdmaps_example_w_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps.c @addtogroup dmaps_v2_4
@{ This file contains the implementation of the interface functions for XDmaPs
driver. Refer to the header file xdmaps.h for more detailed information. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 hbm
08/19/2010 First Release 1.00 nm 05/25/2011 Updated for minor doxygen
corrections 1.02a sg 05/16/2012 Made changes for doxygen and moved some function
header from the xdmaps.h file to xdmaps.c file Other cleanup for coding
guidelines and CR 657109 and CR 657898 1.03a sg 07/16/2012 changed inline to
__inline for CR665681 1.04a nm 10/22/2012 Fixed CR 681671. 1.05a nm 04/15/2013
Fixed CR 704396. Removed warnings when compiled with -Wall and -Wextra option in
bsp. 05/01/2013 Fixed CR 700189. Changed XDmaPs_BuildDmaProg() function
description. Fixed CR 704396. Removed unused variables UseM2MByte & MemBurstLen
from XDmaPs_BuildDmaProg() function. 1.07a asa 11/02/13. Made changes to fix
compilation issues for iarcc. Removed the PDBG prints. By default they were
always defined out and never used. The PDBG is non-standard for Xilinx drivers
and no other driver does something similar. Since there is no easy way to fix
compilation issues with the IARCC compiler around PDBG, it is better to remove
it. Users can always use xil_printfs if they want to debug. 2.01 kpc 08/23/14
Fixed the IAR compiler reported errors 2.2 mus 12/08/16 Remove definition of
INLINE macro to avoid re-definition, since it is being defined in xil_io.h 2.3
kpc 14/10/16 Fixed the compiler error when optimization O0 is used. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dmaps/src/xdmaps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps.h @addtogroup dmaps_v2_4
@{ @details <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 hbm 08/19/10 First Release 1.01a nm 12/20/12 Added definition
XDMAPS_CHANNELS_PER_DEV which specifies the maximum number of channels. Replaced
the usage of XPAR_XDMAPS_CHANNELS_PER_DEV with XDMAPS_CHANNELS_PER_DEV defined
in xdmaps_hw.h. Added the tcl file to automatically generate the xparameters.h
1.02a sg 05/16/12 Made changes for doxygen and moved some function header from
the xdmaps.h file to xdmaps.c file Other cleanup for coding guidelines and CR
657109 and CR 657898 The xdmaps_example_no_intr.c example is removed as it is
using interrupts and is similar to the interrupt example - CR 652477 1.03a sg
07/16/2012 changed inline to __inline for CR665681 1.04a nm 10/22/2012 Fixed CR
681671. 1.05a nm 04/15/2013 Fixed CR 704396. Removed warnings when compiled with
-Wall and -Wextra option in bsp. 05/01/2013 Fixed CR 700189. Changed
XDmaPs_BuildDmaProg() function description. Fixed CR 704396. Removed unused
variables UseM2MByte & MemBurstLen from XDmaPs_BuildDmaProg() function. 1.07a
asa 11/02/13. Made changes to fix compilation issues for iarcc. Removed the PDBG
prints. By default they were always defined out and never used. The PDBG is non-
standard for Xilinx drivers and no other driver does something similar. Since
there is no easy way to fix compilation issues with the IARCC compiler around
PDBG, it is better to remove it. Users can always use xil_printfs if they want
to debug. 2.0 adk 10/12/13 Updated as per the New Tcl API's 2.01 kpc 08/23/14
Fixed the IAR compiler reported errors 2.2 mus 08/12/16 Declared all inline
functions in xdmaps.c as extern, to avoid linker error for IAR compiler 2.3 ms
01/23/17 Modified xil_printf statement in main function for all examples to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. 2.4 adk 13/08/18 Fixed armcc compiler
warnings in the driver CR-1008310. </pre>

FILES:
XilinxProcessorIPLib/drivers/dmaps/src/xdmaps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps_g.c @addtogroup
dmaps_v2_4 @{ This file contains a configuration table where each entry is a
configuration structure for an XDmaPs device in the system. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 hbm 08/19/2010 First
Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dmaps/src/xdmaps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps_hw.c @addtogroup
dmaps_v2_4 @{ This file contains the implementation of the interface reset
functionality for XDmaPs driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.06a kpc 10/07/13 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dmaps/src/xdmaps_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps_hw.h @addtogroup
dmaps_v2_4 @{ This header file contains the hardware interface of an XDmaPs
device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a hbm 08/18/10 First Release 1.01a nm 12/20/12 Added definition
XDMAPS_CHANNELS_PER_DEV which specifies the maximum number of channels. Replaced
the usage of XPAR_XDMAPS_CHANNELS_PER_DEV with XDMAPS_CHANNELS_PER_DEV defined
in xdmaps_hw.h 1.02a sg 05/16/12 Made changes for doxygen 1.06a kpc 07/10/13
Added function prototype </pre>

FILES:
XilinxProcessorIPLib/drivers/dmaps/src/xdmaps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps_selftest.c @addtogroup
dmaps_v2_4 @{ This file contains the self-test functions for the XDmaPs driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 hbm
03/29/2010 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dmaps/src/xdmaps_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmaps_sinit.c @addtogroup
dmaps_v2_4 @{ The implementation of the XDmaPs driver's static initialzation
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 hbm 08/13/10 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dmaps/src/xdmaps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 5.3 ms 04/18/17 Modified tcl file to add suffix U
for all macros definitions of dp in xparameters.h

FILES:
XilinxProcessorIPLib/drivers/dp12/data/dp12.tcl
XilinxProcessorIPLib/drivers/dp14/data/dp14.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_rx_mst_example.c Contains a
design example using the XDp driver with multi-stream transport (MST)
functionality. @note This example requires an AXI timer in the system. @note
This example requires an interrupt controller in the system. @note For this
example to work, the user will need to implement initialization of the system
(Dprx_PlatformInit) as this is system-specific. @note For this example to
display output, the user will need to implement the Dprx_Vidpipe functions which
configure and reset the video pipeline as required as this is system-specific.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 2.0 als
06/07/15 Initial creation. 4.0 als 02/07/16 Added end of line reset for reduced
blanking. Allocate payload ISR to call XDp_RxAllocatePayloadStream. 5.1 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_rx_mst_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_rx_mst_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_rx_sst_dp159_example.c
Contains a design example using the XDp driver for an DP RX core generated with
SST-only functionality. This example runs the programming sequence for the DP159
retimer. An I2C controller will need to exist in the design have a connection to
the DP159. A user-defined hook is used for delay. The reasoning behind this is
that MicroBlaze sleep is not very accurate without a hardware timer. For systems
that have a hardware timer, the user may override the default MicroBlaze sleep
with a function that will use the hardware timer. Also, this example sets up the
interrupt controller and defines handlers for various interrupt types. In this
way, the RX interrupt handler will arbitrate the different interrupts to their
respective interrupt handlers defined in this example. This example will print
out the detected resolution of the incoming DisplayPort video stream. This
example is meant to take in the incoming DisplayPort video stream and pass it
through using the Dprd_Vidpipe functions which are left for the user to
implement. @note This example requires an AXI timer in the system. @note For
this example to work, the user will need to implement initialization of the
system (Dprx_PlatformInit) as this is system-specific. @note For this example to
display output, the user will need to implement the Dprx_Vidpipe functions which
configure and reset the video pipeline as required as this is system-specific.
@note In the presence of a DP159 retimer, an I2C controller needs to exist in
the design to program it. Depending on how the DP159 connection exists, the user
will need to implement Dprx_Dp159Reset function. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 als 01/20/15 Initial creation. 2.0 als
07/07/15 Added DP159 programming. 4.0 als 02/07/16 Added end of line reset for
reduced blanking. 5.1 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_rx_sst_dp159_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_rx_sst_dp159_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_selftest_example.c Contains
a design example using the XDp driver. It performs a self test on the
DisplayPort TX/RX core that will compare many of the DisplayPort core's
registers against their default reset values. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 01/20/15 Initial
creation. 5.1 ms 01/23/17 Added xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_selftest_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_tx_audio_example.c Contains
a design example using the XDp driver (operating in TX mode) to train the main
link and to display video. In this example application, the sequence to enable
audio is illustrated. @note This example requires an audio source such as an
S/PDIF instance to be part of the hardware system. See XAPP1178 for reference.
@note This example requires that the audio enable configuration parameter for
DisplayPort be turned on when creating the hardware design. @note For this
example to output audio, the user will need to implement initialization of the
system (Dptx_PlatformInit), configuration of the audio source
(Dptx_ConfigureAudioSrc) and, depending on the hardware system, will need to
implement sending of an info frame (Dptx_AudioSendInfoFrame). See XAPP1178 and
the IP documentation for reference. @note For this example to display output,
after training is complete, the user will need to implement configuration of the
video stream source in order to provide the DisplayPort core with input
(Dptx_StreamSrc - called in xdp_tx_example_common.c). See XAPP1178 for
reference. @note The functions Dptx_PlatformInit and Dptx_StreamSrc are declared
extern in xdp_tx_example_common.h and are left up to the user to implement. The
functions Dptx_ConfigureAudioSrc and Dptx_AudioSendInfoFrame are present in this
file and are also left for the user to implement. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 als 01/20/15 Initial creation. 5.1
ms 01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_tx_audio_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_tx_audio_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_tx_example_common.c
Contains a design example using the XDp driver (operating in TX mode). It
performs a self test on the DisplayPort TX core by training the main link at the
maximum common capabilities between the TX and RX and checking the lane status.
@note The DisplayPort TX core does not work alone - video/audio sources need to
be set up in the system correctly, as well as setting up the output path (for
example, configuring the hardware system with the DisplayPort TX core output to
an FMC card with DisplayPort output capabilities. Some platform initialization
will need to happen prior to calling XDp driver functions. See XAPP1178 as a
reference. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 als 01/20/15 Initial creation. 5.1 ms 01/23/17 Added xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_tx_example_common.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_tx_example_common.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_tx_example_common.h
Contains a design example using the XDp driver (operating in TX mode). It
performs a self test on the DisplayPort TX core by training the main link at the
maximum common capabilities between the TX and RX and checking the lane status.
@note The DisplayPort TX core does not work alone - video/audio sources need to
be set up in the system correctly, as well as setting up the output path (for
example, configuring the hardware system with the DisplayPort TX core output to
an FMC card with DisplayPort output capabilities. Some platform initialization
will need to happen prior to calling XDp driver functions. See XAPP1178 as a
reference. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 als 01/20/15 Initial creation. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_tx_example_common.h
XilinxProcessorIPLib/drivers/dp14/examples/xdp_tx_example_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_tx_intr_example.c Contains
a design example using the XDp driver (operating in TX mode) with interrupts.
Upon Hot-Plug-Detect (HPD - DisplayPort cable is plugged/unplugged or the
monitor is turned on/off), the main link will be trained. @note This example
requires an interrupt controller connected to the processor and the DisplayPort
TX core in the system. @note For this example to display output, the user will
need to implement initialization of the system (Dptx_PlatformInit) and, after
training is complete, implement configuration of the video stream source in
order to provide the DisplayPort core with input (Dptx_StreamSrc - called in
xdp_tx_example_common.c). See XAPP1178 for reference. @note The functions
Dptx_PlatformInit and Dptx_StreamSrc are declared extern in
xdp_tx_example_common.h and are left up to the user to implement. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 01/20/15
Initial creation. 5.1 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_tx_intr_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_tx_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_tx_mst_example.c Contains a
design example using the XDp driver (operating in TX mode) in multi-stream
transport (MST) mode. @note For this example to display output, the user will
need to implement initialization of the system (Dptx_PlatformInit) and, after
training is complete, implement configuration of the video stream source in
order to provide the DisplayPort core with input. See XAPP1178 for reference.
@note The functions Dptx_PlatformInit and Dptx_StreamSrc are declared extern in
xdp_tx_example_common.h and are left up to the user to implement. @note Some
setups may require introduction of delays when sending sideband messages. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 01/20/15
Initial creation. 5.1 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_tx_mst_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_tx_mst_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_tx_poll_example.c Contains
a design example using the XDp driver (operating in TX mode) with polling. Once
the polling detects a Hot-Plug-Detect event (HPD - DisplayPort cable is
plugged/unplugged or the monitor is turned on/off), the main link will be
trained. @note For this example to display output, the user will need to
implement initialization of the system (Dptx_PlatformInit) and, after training
is complete, implement configuration of the video stream source in order to
provide the DisplayPort core with input (Dptx_StreamSrc - called in
xdp_tx_example_common.c). See XAPP1178 for reference. @note The functions
Dptx_PlatformInit and Dptx_StreamSrc are declared extern in
xdp_tx_example_common.h and are left up to the user to implement. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 01/20/15
Initial creation. 5.1 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_tx_poll_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_tx_poll_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_tx_timer_example.c Contains
a design example using the XDp driver (operating in TX mode) with a user-defined
hook for delay. The reasoning behind this is that MicroBlaze sleep is not very
accurate without a hardware timer. For systems that have a hardware timer, the
user may override the default MicroBlaze sleep with a function that will use the
hardware timer. @note This example requires an AXI timer in the system. @note
For this example to display output, the user will need to implement
initialization of the system (Dptx_PlatformInit) and, after training is
complete, implement configuration of the video stream source in order to provide
the DisplayPort core with input (Dptx_StreamSrc - called in
xdp_tx_example_common.c). See XAPP1178 for reference. @note The functions
Dptx_PlatformInit and Dptx_StreamSrc are declared extern in
xdp_tx_example_common.h and are left up to the user to implement. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 01/20/15
Initial creation. 5.1 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/examples/xdp_tx_timer_example.c
XilinxProcessorIPLib/drivers/dp14/examples/xdp_tx_timer_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp.c @addtogroup dp_v6_0 @{
Contains a minimal set of functions for the XDp driver that allow access to all
of the DisplayPort core's functionality. See xdp.h for a detailed description of
the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 als 01/20/15 Initial release. TX code merged from the dptx
driver. 2.0 als 06/08/15 Updated RX initialization with MST support. Added
callbacks for lane count changes, link rate changes and pre-emphasis + voltage
swing adjust requests. 5.1 als 08/09/16 Replaced deprecated MB_Sleep with
consolidated usleep. 08/11/16 RX to support maximum pre-emphasis level of 1.
08/12/16 Updates to support 64-bit base addresses. 5.2 aad 01/21/17 Added
training timeout disable for RX MST mode for soft-disconnect to work. 6.0 tu
05/14/17 Added AUX defer to 6 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp.h @addtogroup dp_v6_0 @{
@details The Xilinx DisplayPort transmitter (DP) driver. This driver supports
the Xilinx DisplayPort soft IP core in both transmit/source (TX) and
receive/sink (RX) modes of operation. The Xilinx DisplayPort soft IP supports
the following features: - 1, 2, or 4 lanes. - A link rate of 1.62, 2.70, or
5.40Gbps per lane. - 1, 2, or 4 pixel-wide video interfaces. - RGB and YCbCr
color space. - Up to 16 bits per component. - Up to 4Kx2K monitor resolution. -
Auto lane rate and width negotiation. - I2C over a 1Mb/s AUX channel. -
Secondary channel audio support (2 channels). - 4 independent video multi-
streams. The Xilinx DisplayPort soft IP does not support the following features:
- The automated test feature. - Audio (3-8 channel). - FAUX. - Bridging
function. - MST audio. - eDP optional features. - iDP. - GTC. <b>DisplayPort
overview</b> A DisplayPort link consists of: - A unidirectional main link which
is used to transport isochronous data streams such as video and audio. The main
link may use 1, 2, or 4 lanes at a link rate of 1.62, 2.70, or 5.40Gbps per
lane. The link needs to be trained prior to sending streams. - An auxiliary
(AUX) channel is a 1MBps bidirectional channel used for link training, link
management, and device control. - A hot-plug-detect (HPD) signal line is used to
determine whether a DisplayPort connection exists between the DisplayPort TX
connector and an RX device. It is serves as an interrupt request by the RX
device. <b>Device configuration</b> The device can be configured in various ways
during the FPGA implementation process. Configuration parameters are stored in
the xdp_g.c file which is generated when compiling the board support package
(BSP). A table is defined where each entry contains configuration information
for the DisplayPort instances present in the system. This information includes
parameters that are defined in the driver's data/dp.tcl file such as the base
address of the memory-mapped device and the maximum number of lanes, maximum
link rate, and video interface that the DisplayPort instance supports, among
others. The DisplayPort core may be configured in both transmitter (TX) or
receiver (RX) modes of operation. Depending on which mode of operation the
hardware is configured for, the set of registers associated with the core will
be different. <b>Driver description</b> The DisplayPort (DP) driver consists of
functions, structures, and definitions: 1) Specific to the DisplayPort TX mode
of operation. - Prefix: XDp_Tx and XDP_TX_ 2) Specific to the DisplayPort RX
mode of operation. - Prefix: XDp_Rx and XDP_RX_ 3) Common to both DisplayPort
modes of operation. - Prefix: XDp_ and XDP_ <b>Driver description: TX mode of
operation</b> The device driver enables higher-level software (e.g., an
application) to configure and control a DisplayPort TX soft IP, communicate and
control an RX device/sink monitor over the AUX channel, and to initialize and
transmit data streams over the main link. This driver follows the DisplayPort
1.2a specification. This driver implements link layer functionality: a Link
Policy Maker (LPM) and a Stream Policy Maker (SPM) as per the DisplayPort 1.2a
specification. - The LPM manages the main link and is responsible for keeping
the link synchronized. It will establish a link with a downstream RX device by
undergoing a link training sequence which consists of: - Clock recovery: The
clock needs to be recovered and PLLs need to be locked for all lanes. - Channel
equalization: All lanes need to achieve channel equalization and and symbol
lock, as well as for interlane alignment to take place. - The SPM manages
transportation of an isochronous stream. That is, it will initialize and
maintain a video stream, establish a virtual channel to a sink monitor, and
transmit the stream. Using AUX transactions to read/write from/to the sink's
DisplayPort Configuration Data (DPCD) address space, the LPM obtains the link
capabilities, obtains link configuration and link and sink status, and
configures and controls the link and sink. The main link is trained this way.
I2C-over-AUX transactions are used to obtain the sink's Extended Display
Identification Data (EDID) which give information on the display capabilities of
the monitor. The SPM may use this information to determine what available screen
resolutions and video timing are possible. <b>Driver description: RX mode of
operation</b> The device driver enables higher-level software (e.g., an
application) to configure and control a DisplayPort RX soft IP. This driver
gives applications the ability to configure the RX using various settings,
handle and issue interrupts, and modify a subset of its DisplayPort
Configuration Data (DPCD) fields. Link training is done automatically by the
hardware. <b>Interrupt processing</b> For the driver to process interrupts, the
application must set up the system's interrupt controller and connect the
XDp_InterruptHandler function to service interrupts. When an interrupt occurs,
XDp_InterruptHandler will check which mode of operation the DisplayPort core is
running in, and will call the appropriate interrupt handler for that core
(XDp_TxInterruptHandler or XDp_RxInterruptHandler - local to xdp_intr.c).
<b>Interrupt processing: TX mode of operation</b> DisplayPort interrupts occur
on the HPD signal line when the DisplayPort cable is connected/disconnected or
when the RX device sends a pulse. The user hardware design must contain an
interrupt controller which the DisplayPort TX instance's interrupt signal is
connected to. The user application must enable interrupts in the system and set
up the interrupt controller such that the XDp_TxHpdInterruptHandler handler will
service DisplayPort interrupts. When the XDp_TxHpdInterruptHandler function is
invoked, the handler will identify what type of DisplayPort interrupt has
occurred, and will call either the HPD event handler function or the HPD pulse
handler function, depending on whether a an HPD event on an HPD pulse event
occurred. The DisplayPort TX's XDP_TX_INTERRUPT_STATUS register indicates the
type of interrupt that has occurred, and the XDp_TxInterruptHandler will use
this information to decide which handler to call. An HPD event is identified if
bit XDP_TX_INTERRUPT_STATUS_HPD_EVENT_MASK is set, and an HPD pulse is
identified from the XDP_TX_INTERRUPT_STATUS_HPD_PULSE_DETECTED_MASK bit. The HPD
event and HPD pulse handler may be set up by using the XDp_TxSetCallback
function and XDP_TX_HANDLER_HPDEVENT and XDP_TX_HANDLER_HPDPULSE enumerations of
the XDp_Tx_HandlerType type. <b>Interrupt processing: RX mode of operation</b>
The DisplayPort RX driver may generate a pulse on the hot-plug-detect (HPD)
signal line using the XDp_RxGenerateHpdInterrupt function. This allows the RX to
send an interrupt to the upstream TX device, useful for signaling the TX that it
needs to do some checks for changes in downstream devices or a loss of link
training. For RX interrupt handling of HPD events or events that happen internal
to the RX, the user hardware design must contain an interrupt controller which
the DisplayPort RX instance's interrupt signal is connected to. The user
application must enable interrupts in the system and set up the interrupt
controller such that the XDp_RxInterruptHandler handler will service interrupts.
When the XDp_RxInterruptHandler function is invoked, the handler will identify
what type of interrupt has occurred, and will call the appropriate interrupt
handler. The DisplayPort RX's XDP_RX_INTERRUPT_CAUSE register indicates the type
of interrupt that has occured, and the XDp_RxInterruptHandler will use this
information to decide which handler to call. The handlers are set up using the
XDp_RxSetIntr functions. Specific interrupts may be enabled or disabled using
the XDp_RxInterruptEnable and XDp_RxInterruptDisable functions. <b>Multi-stream
transport (MST) mode: TX mode of operation</b> The driver handles MST mode
functionality in TX mode of operation, including sideband messaging, topology
discovery, virtual channel payload ID table management, and directing streams to
different sinks. MST testing has been done at all possible link rate/lane
count/topology/ resolution/color depth combinations with each setting using
following values: - Link rate: 1.62, 2.70, and 5.40Gbps per lane. - Lane count:
1, 2, and 4 lanes. - Number of sink displays: 1, 2, 3, and 4 sink displays in
both a daisy-chain configuration and in a configuration using a combination of a
1-to-3 hub and daisy-chain. Each stream was using the same resolution. -
Resolutions (60Hz): 640x480, 800x600, 1024x768, 1280x800, 1280x1024, 1360x768,
1400x1050, 1680x1050, 1920x1080, 1920x2160, and 3840x2160. - Color depths: 18,
24, 30, 36, and 48 bits per pixel. <b>Multi-stream transport (MST) mode: RX mode
of operation</b> The driver handles MST mode functionality in RX mode of
operation. The API function, XDp_RxHandleDownReq, will read a sideband message
from the down request registers in the DisplayPort RX core, parse it, arbitrate
control for the sideband message type that was requested, format a reply, and
send the reply. The current version of the driver only supports a software
representation of a shallow topology - meaning virtual sinks are defined in the
user application and assigned to port numbers. The RX acts as a branch connected
to multiple sinks, but is not connected to another branch. Sideband messages
will then be handled for the targeted downstream sink. The user application
creates the topology using the driver's API functions: - XDp_RxSetIicMapEntry :
Used to specify the I2C contents of a virtual sink. - XDp_RxSetDpcdMap : Used to
specify the DPCD of a virtual sink. - XDp_RxMstSetPbn : Used to specify the
available PBN of a virtual sink. - XDp_RxMstSetPort : Used to specify how the
sink will appear when the an upstream device sends a LINK_ADDRESS sideband
request to the RX branch. - XDp_RxMstSetInputPort : Used to specify the input
port. - XDp_RxMstExposePort : Used to enable the port by exposing it to incoming
LINK_ADDRESS sideband requests. The driver will keep track of the topology in
the structures: - XDp_RxTopology : Stores topology information as a reply to
LINK_ADDRESS requests, the virtual channel payload table, and port
representations (XDp_RxPort[] type). - XDp_RxPort : Stores the I2C map
(XDp_RxIicMapEntry[] type), DPCD address space (XDp_RxDpcdMap type), PBN
information, and whether or not the represented sink is exposed to upstream
devices. - XDp_RxIicMapEntry : Represents data stored at an associated I2C
address. - XDp_RxDpcdMap : Represents the DPCD of an associated port's sink.
Note that the driver uses the topology's XDp_RxPort[] array such that the
indices match the port number that attaches the virtual sink to the RX branch.
The following sideband messages are supported: - CLEAR_PAYLOAD_ID_TABLE -
LINK_ADDRESS - REMOTE_I2C_READ - REMOTE_DPCD_READ - ENUM_PATH_RESOURCES -
ALLOCATE_PAYLOAD Other sideband messages are replied to with NACK. <b>Audio</b>
The driver in RX mode of operation may received audio info and extension
packets. When this happens, if interrupts are enabled, the appropriate handlers
will be invoked. Control functions are available for enabling, disabling, and
resetting audio in the DisplayPort RX core. The TX driver does not handle audio.
For an example as to how to configure and transmit audio,
examples/xdptx_audio_example.c illustrates the required sequence in the TX mode
of operation. The user will need to configure the audio source connected to the
Displayport TX instance and set up the audio info frame as per user
requirements. <b>Asserts</b> Asserts are used within all Xilinx drivers to
enforce constraints on argument values. Asserts can be turned off on a system-
wide basis by defining, at compile time, the NDEBUG identifier. By default,
asserts are turned on and it is recommended that application developers leave
asserts on during development. <b>Limitations: TX mode of operation</b> - For
MST mode to correctly display, the current version of the driver requires that
each of the DisplayPort TX streams be allocated without skipping streams (i.e.
assign stream 1, stream 2, and stream 3 - problems were experienced if skipping
stream 2 and assigning stream 4 instead). skipping monitors in a daisy chain is
OK as long as they are assigned to streams in order. - In MST mode, the current
version of the driver does not support removal of an allocated stream from the
virtual channel payload ID table without clearing the entire table. - Some
sideband messages have not been implemented in the current version of the driver
for MST mode. Notably, reception of a CONNECTION_STATUS_NOTIFY sideband message.
- The driver does not handle audio. See the audio example in the driver examples
directory for the required sequence for enabling audio. <b>Limitations: RX mode
of operation</b> - Sideband messages that aren't supported as specified above
will be NACK'ed. @note For a 5.4Gbps link rate, a high performance 7 series FPGA
is required with a speed grade of -2 or -3. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 als 01/20/15 Initial release. TX code
merged from the dptx driver. 2.0 als 06/08/15 Added MST functionality to RX. New
APIs: XDp_RxHandleDownReq, XDp_RxGetIicMapEntry, XDp_RxSetIicMapEntry,
XDp_RxSetDpcdMap, XDp_RxMstExposePort, XDp_RxMstSetPort, XDp_RxMstSetInputPort,
XDp_RxMstSetPbn, XDp_RxSetIntrDownReqHandler, XDp_RxSetIntrDownReplyHandler,
XDp_RxSetIntrAudioOverHandler, XDp_RxSetIntrPayloadAllocHandler,
XDp_RxSetIntrActRxHandler, XDp_RxSetIntrCrcTestHandler Added IntrHandler and
IntrCallbackRef interrupt-related members to XDp_Rx structure for: DownReq,
DownReply, AudioOver, PayloadAlloc, ActRx, CrcTest Added new data structures
related to RX MST topology: XDp_RxIicMapEntry, XDp_RxDpcdMap, XDp_RxPort,
XDp_RxTopology Renamed XDp_Tx to XDp_ to reflect commonality with RX for:
XDp_TxSbMsgLinkAddressReplyPortDetail XDp_TxSbMsgLinkAddressReplyDeviceInfo GUID
type change for ease of use: 'u32 Guid[4]' changed to 'u8 Guid[16]' Added
handlers and setter functions for HDCP and unplug events. Added callbacks for
lane count changes, link rate changes and pre-emphasis + voltage swing adjust
requests. 3.0 als 10/07/15 Added MSA callback. 4.0 als 12/08/15 Added link rate
and lane count validity check APIs: XDp_IsLinkRateValid XDp_IsLaneCountValid
XDp_TxAllocatePayloadVcIdTable now takes an additional argument (StartTs, the
starting timeslot). Added RX API to get color depth of a given stream.
XDp_RxGetBpc Added RX API to get color component format of a stream.
XDp_RxGetColorComponent Added RX API to set end of line reset as appropriate.
XDp_RxSetLineReset Added RX MST API to allocate payload from ISR:
XDp_RxAllocatePayloadStream 5.0 als 05/16/16 Added APIs to set color encoding
scheme. 5.1 als 08/12/16 Updates to support 64-bit base addresses. ms 01/23/17
Added xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Modified readme.txt file in examples folder for
doxygen generation. 5.3 ms 04/18/17 Modified tcl file to add suffix U for all
macros definitions of dp in xparameters.h 6.0 tu 09/08/17 Added two interrupt
handler that addresses driver's internal callback function of application
DrvHpdEventHandler and DrvHpdPulseHandler 6.0 tu 09/08/17 Added three interrupt
handler that addresses callback function of driver </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_edid.c @addtogroup dp_v6_0
@{ This file contains functions related to accessing the Extended Display
Identification Data (EDID) of a specified sink using the XDp driver operating in
TX mode. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 01/20/15 Initial release. TX code merged from the dptx driver.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp_edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_hw.h @addtogroup dp_v6_0 @{
This header file contains the identifiers and low-level driver functions (or
macros) that can be used to access the device. High-level driver functions are
defined in xdp.h. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 als 01/20/15 Initial release. TX code merged from the
dptx driver. 2.0 als 06/08/15 Added MST registers, masks, and values for RX.
Added HDCP registers and masks. 5.0 als 05/16/16 Added MISC0 and MISC1
definitions. 5.1 aad 08/16/16 Updated MISC0 definitions. 5.2 aad 01/21/17 Added
timeout macro for training timeout 6.0 tu 05/14/17 Added AUX defer shift mask
6.0 tu 08/03/17 Enabled video packing for bpc > 10 6.0 tu 08/24/17 Modify define
for YCBCR422 and YCBCR444 </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_intr.c @addtogroup dp_v6_0
@{ This file contains functions related to XDp interrupt handling. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als
01/20/15 Initial release. TX code merged from the dptx driver. 2.0 als 06/08/15
Added MST interrupt handlers for RX. Guard against uninitialized callbacks.
Added HDCP interrupts. Added unplug interrupt. 4.0 als 02/18/16 Removed update
of payload table in the driver's interrupt handler. 6.0 tu 05/30/17 Removed
unused variable in XDp_RxInterruptHandler 6.0 tu 09/08/17 Added two interrupt
handler that addresses driver's internal callback function of application
DrvHpdEventHandler and DrvHpdPulseHandler 6.0 tu 09/08/17 Added three interrupt
handler that addresses callback function of application </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_mst.c @addtogroup dp_v6_0
@{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als
01/20/15 Initial release. TX code merged from the dptx driver. 2.0 als 06/08/15
Added MST functionality to RX. 4.0 als 02/16/16 XDp_TxAllocatePayloadStreams now
allocates payloads by using an internally calculated starting timeslot for each
stream rather than invoking XDp_TxGetFirstAvailableTs.
XDp_TxAllocatePayloadVcIdTable now takes an additional argument (StartTs, the
starting timeslot). Exposed RX MST API to application:
XDp_RxAllocatePayloadStream 5.2 aad 01/24/16 XDp_RxAllocatePayloadStream now
adjusts to timeslot rearragement 6.0 tu 05/30/17 Initialized variable in
XDp_RxDeviceInfoToRawData </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp_mst.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_selftest.c @addtogroup
dp_v6_0 @{ This file contains a diagnostic self-test function for the XDp
driver. It will check many of the DisplayPort core's register values against the
default reset values as a sanity-check that the core is ready to be used. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
als 01/20/15 Initial release. TX code merged from the dptx driver. 5.0 als
07/27/16 8B10B enable is now set by default in PHY_CONFIG reg. 6.0 tu 08/04/17
Changed Selftest regiter's default value. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_sinit.c @addtogroup dp_v6_0
@{ This file contains static initialization methods for the XDp driver. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
als 01/20/15 Initial release. TX code merged from the dptx driver. 6.0 tu
02/06/17 Initialize CfgPtr to NULL. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_spm.c @addtogroup dp_v6_0
@{ This file contains the stream policy maker functions for the XDp driver.
These functions set up the DisplayPort TX core's main stream attributes (MSA)
that determine how a video stream will be displayed and also some DisplayPort RX
MSA-related functions. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 als 01/20/15 Initial release. TX code merged
from the dptx driver. 2.0 als 07/27/15 Scale TX fractional register by 1024
instead of 1000. 3.0 als 10/07/15 Added MSA callback. 4.0 als 02/07/16
Enable/disable end of line reset for reduced blanking. 5.0 als 05/16/16 Added
API to set color encoding scheme. 5.1 als 08/03/16 Use video common API rather
than internal structure when checking for interlaced mode. als 08/12/16 Updates
to support 64-bit base addresses. 5.2 aad 01/24/17 Disable end of line reset for
reduced blanking 6.0 tu 07/20/17 Allowing Custom VTM in
XDp_TxCfgMsaUseStandardVideoMode function. 6.0 aad 09/05/17 Reverted to enable
end of line reset for RB resolutions. 6.0 tu 09/06/17 Added Set UserPixelWidth
support on tx side </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12/src/xdp_spm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"),to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/data/dp12rxss.mdd
XilinxProcessorIPLib/drivers/dp12txss/data/dp12txss.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"),to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 2.00 sha 10/05/15 Added Timer Counter support. 3.0 sha
02/05/16 Added support to generate XPAR_ parameters for multiple subsystems in a
design. 4.0 tu 27/06/17 Updated parameter AUDIO_CHANNELS name

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/data/dp12rxss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_debug_example.c This
file contains a design example using the XDpRxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode and provides DisplayPort RX
Subsystem debug information at runtime. @note For this example to display
output, the user need to implement initialization of the system
(DpRxSs_PlatformInit), Video Phy (DpRxSs_VideoPhyInit), start DisplayPort RX
subsystem (XDpRxSs_Start) and DisplayPort RX Subsystem setup (DpRxSs_Setup). The
input to the Subsystem is from RX (GT). The functions DpRxSs_PlatformInit,
DpRxSs_VideoPhyInit and DpRxSs_Setup are declared and are left up to the user to
implement. In addition to the setups, this example requires to implement
required interrupts to view the output. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 07/29/15 Initial release. 2.00 sha 10/05/15
Changed DpTxSs_Setup DpRxSs_Setup. Added HDCP debug function. 4.00 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/xdprxss_debug_example.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/xdprxss_debug_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_hdcp_example.c This
file contains a design example using the XDpRxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode and enables HDCP. @note For this
example to display output, the user need to implement initialization of the
system (DpRxSs_PlatformInit), Video Phy (DpRxSs_VideoPhyInit), start DisplayPort
RX subsystem (XDpRxSs_Start) and DisplayPort RX Subsystem setup (DpRxSs_Setup).
The input to the Subsystem is from RX (GT). The functions DpRxSs_PlatformInit,
DpRxSs_VideoPhyInit and DpRxSs_Setup are declared and are left up to the user to
implement. In addition to the setups, this example requires to implement
required interrupts to view the output. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 10/05/15 Initial release. 4.00 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/xdprxss_hdcp_example.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/xdprxss_hdcp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_intr_example.c This
file contains a design example using the XDpRxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode with interrupts. Upon unplug
event (DisplayPort cable is unplugged/plugged), DisplayPort RX Subsystem will
program DP159 disconnect sequence or DP159 training pattern 1, 2, 3 sequences
respectively. @note This example requires an interrupt controller connected to
the processor and the DisplayPort RX Subsystem HIP is in the system. For this
example to display output, the user need to implement initialization of the
system (DpRxSs_PlatformInit), Video Phy (DpRxSs_VideoPhyInit), start DisplayPort
RX subsystem (XDpRxSs_Start) and DisplayPort RX Subsystem setup (DpRxSs_Setup).
The input to the Subsystem is from RX (GT). The functions DpRxSs_PlatformInit,
DpRxSs_VideoPhyInit and DpRxSs_Setup are declared and are left up to the user to
implement. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- --------
1.00 sha 07/29/15 Initial release. 2.00 sha 10/05/15 Changed DpTxSs_Setup
DpRxSs_Setup. Removed HDCP callbacks registration and callbacks. Added HDCP and
Timer Counter interrupt handler setup. 4.00 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/xdprxss_intr_example.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/xdprxss_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_mst_example.c This file
contains a design example using the XDpRxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode. @note For this example to
display output, the user need to implement initialization of the system
(DpRxSs_PlatformInit), Video Phy (DpRxSs_VideoPhyInit), start DisplayPort RX
subsystem (XDpRxSs_Start) and DisplayPort RX Subsystem setup (DpRxSs_Setup). The
input to the Subsystem is from RX (GT). This example requires an interrupt
controller in the system. The functions DpRxSs_PlatformInit, DpRxSs_VideoPhyInit
and DpRxSs_Setup are declared and are left up to the user to implement. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 07/29/15
Initial release. 2.00 sha 10/05/15 Changed DpTxSs_Setup DpRxSs_Setup. 4.00 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/xdprxss_mst_example.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/xdprxss_mst_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_selftest_example.c This
file contains a design example using the XDpRxSs driver. It performs a self test
on the DisplayPort transmitter Subsystem Hierarchical IP that will test its sub-
cores self test functions. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 07/29/15 Initial release. 4.00 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/xdprxss_selftest_example.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/xdprxss_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_debug.c This
file provides the implement of the HDCP debug commands <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 07/16/15 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/com/xhdcp1x_debug.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/com/xhdcp1x_debug.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_debug.h This
file provides the interface of the HDCP debug commands <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 07/16/15 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/com/xhdcp1x_debug.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/com/xhdcp1x_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_example.c
This file provides the implementation of the HDCP example <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 07/16/15 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/com/xhdcp1x_example.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/com/xhdcp1x_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_example.h
This file provides the interface of the HDCP example <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 07/16/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/com/xhdcp1x_example.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/com/xhdcp1x_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file LMK04906.h This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI
07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/inc/LMK04906.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/inc/LMK04906.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file PLL_Conf.h This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI
07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/inc/PLL_Conf.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/inc/PLL_Conf.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt.h This file
contains functions to configure Video Pattern Generator core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 YB 07/01/15 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/inc/xclk_wiz.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/inc/xclk_wiz.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xedid_print_example.h This file contains functions to configure Video Pattern
Generator core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 YB 07/01/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/inc/xedid_print_example.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/inc/xedid_print_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file LMK04906.c This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI
07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/LMK04906.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/LMK04906.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/LMK04906.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/LMK04906.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file PLL_Conf.c This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI
07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/PLL_Conf.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/PLL_Conf.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/PLL_Conf.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/PLL_Conf.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt.h This file
contains functions to configure Video Pattern Generator core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/dppt.h
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/dppt.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/dppt.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/dppt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt_vdma.c This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI
07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/dppt_vdma.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/dppt_vdma.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/dppt_vdma.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/dppt_vdma.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/dppt_vdma.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/dppt_vdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt_vdma.h This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI
07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/dppt_vdma.h
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/dppt_vdma.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/dppt_vdma.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/dppt_vdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
dppt_vid_phy_config.c This file contains functions to configure Video Pattern
Generator core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 KI 07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/dppt_vid_phy_config.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/dppt_vid_phy_config.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/dppt_vid_phy_config.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/dppt_vid_phy_config.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
dppt_vid_phy_config.h This file contains functions to configure Video Pattern
Generator core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 KI 07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/dppt_vid_phy_config.h
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/dppt_vid_phy_config.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/dppt_vid_phy_config.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/dppt_vid_phy_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file menus.c This file
contains functions to configure Video Pattern Generator core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/menus.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/menus.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/menus.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/menus.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/menus.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/menus.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz.c This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 YB
07/01/15 Initial release. 1.10 KI 08/14/17 Updated for Release mode </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/xclk_wiz.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/xclk_wiz.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdebug.h This file
contains functions to configure Video Pattern Generator core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/xdebug.h
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/xdebug.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/xdebug.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/xdebug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dpp.c MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 KU 04/20/16 Initial release. 1.1 KI
02/15/17 Vivado 2016.4 compartible code 02/23/17 Added compliance related for Rx
03/03/17 Added tx_preset for stability

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/xdprxss_kc705.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/xdptxss_kc705.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xedid_print_example.c This file contains functions to configure Video Pattern
Generator core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 KI 07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/xedid_print_example.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/xedid_print_example.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/xedid_print_example.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/xedid_print_example.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xedid_print_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xedid_print_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvid_pat_gen.c This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 shad
01/29/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/zcu_tx/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/xvid_pat_gen.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvid_pat_gen.h This
is the main header file for Xilinx Video Pattern Generator. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 shad 01/29/15 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kc/xvid_pat_gen.h
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/xvid_pat_gen.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kc/xvid_pat_gen.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/xvid_pat_gen.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xclk_wiz.c This
file contains functions to configure Video Pattern Generator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 YB
07/01/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/xclk_wiz.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/xclk_wiz.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xclk_wiz.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xclk_wiz.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dpp.c MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 KU 04/20/16 Initial release. 1.1 KI
02/15/17 Vivado 2016.4 compartible code 1.2 KI 02/17/17 Added compliance related
for Rx

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/kcu/xdprxss_kcu105.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/kcu/xdptxss_kcu105.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Byte-oriented AES-256
implementation. All lookup tables replaced with 'on the fly' calculations.
Copyright (c) 2007-2009 Ilya O. Levin, http://www.literatecode.com Other
contributors: Hal Finney Permission to use, copy, modify, and distribute this
software for any purpose with or without fee is hereby granted, provided that
the above copyright notice and this permission notice appear in all copies. THE
SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/aes256.c
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/aes256.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/aes256.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/aes256.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

eeprom.c Created on: May 5, 2015 Author: yashova / All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions: The above copyright notice and this
permission notice shall be included in all copies or substantial portions of the
Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE. Variable Definitions /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/eeprom.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/eeprom.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. eeprom.h Created on: May
5, 2015 Author: yashova /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/eeprom.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/eeprom.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt.c This file
contains the implementation for the key management module. Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt.h This file
contains the interface for the key management module.

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_debug.h
This file contains the debug related definitions of the key management software.
@note The contents of this file adjust the definition of the PRINTF and
DEBUG_LOG macros based on the presence/absence of a "FIDUS_BLAZY" definition
from within xparameters.h. It is assumed that is such a definition is present,
then the console infrastructure will be part of the build. Otherwise, the raw
Xilinx BSP functions are called directly.

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_debug.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_device.c
This file contains the implementation for the key management device module.
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_device.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_device.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_device.h
This file contains the interface for the key management module.

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_device.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_device.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_keyfile.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_keyfile.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_loader.c
This file contains the implementation for the key management loader module.
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_loader.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_loader.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_loader.h
This file contains the interface for the key management loader module.

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_loader.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_loader.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_testkeys.c
This file contains the table definitions for the four sets of hdcp test keys
These keys are bogus and HDCP will fail with them Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/key/keymgmt_testkeys.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/key/keymgmt_testkeys.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_rxonly.c This file
contains a design example using the XDpRxSs driver in single stream (SST)
transport mode. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 vk 10/04/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/zcu_rx/xdprxss_zcu102_rxonly.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/xdprxss_vcu118_dp14_rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidframe_crc.c
This is the main header file for the Xilinx HDCP abstraction layer. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 GM 17/07/17
First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/zcu_rx/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/zcu_tx/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/xvidframe_crc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidframe_crc.h
This is the main header file for the Xilinx HDCP abstraction layer. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 GM 17/07/17
First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/examples/src/zcu_rx/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp12txss/examples/src/zcu_tx/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/xvidframe_crc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss.c @addtogroup
dprxss_v4_1 @{ This is the main file for Xilinx DisplayPort Receiver Subsystem
driver. This file contains a minimal set of functions for the XDpRxSs driver
that allow access to all of the DisplayPort Receiver Subsystem core's
functionality. Please see xdprxss.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 05/18/15
Initial release. 2.00 sha 10/05/15 Added HDCP and Timer Counter support.
Protected HDCP under macro number of instances. 2.00 sha 10/15/15 Generate a HPD
interrupt whenever RX cable disconnect/unplug interrupt is detected. 2.00 sha
11/06/15 Modified the order of execution in TP1 callback as DP159 config for TP1
and then link bandwidth callback. 3.0 sha 02/05/16 Added support for multiple
subsystems in a design. 3.0 sha 02/19/16 Added function:
XDpRxSs_DownstreamReady. 3.1 als 08/08/16 Synchronize with new HDCP APIs. 3.1
als 08/08/16 Added HDCP timeout functionality. 3.1 aad 09/06/16 Updates to
support 64-bit base addresses. 3.1 aad 10/17/16 Updated timer initialization 4.0
aad 11/15/16 Modified to use DP159 from dprxss driver 4.0 aad 01/20/17 Added
HDCP FIFO reset for correct initialization of the FIFO 4.0 tu 05/30/17 Moved
timer functions under XPAR_XHDCP_NUM_INSTANCES to solve compiler warnings 4.1 tu
09/08/17 Set Driver side three interrupt handler callback in
XDpRxSs_CfgInitialize function </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss.h @addtogroup
dprxss_v4_1 @{ @details This is the main header file for Xilinx DisplayPort
Receiver Subsystem core. It abstracts Subsystem cores and provides high level
API's to application developer. <b>Core Features</b> For a full description of
DisplayPort Receiver Subsystem core, please see the hardware specification.
<b>Software Initialization & Configuration</b> The application needs to do
following steps in order for preparing the DisplayPort Receiver Subsystem core
to be ready. - Call XDpRxSs_LookupConfig using a device ID to find the core
configuration. - Call XDpRxSs_CfgInitialize to initialize the device and the
driver instance associated with it. <b>Interrupts</b> The DisplayPort RX
Subsystem driver provides the interrupt handlers - XDpRxSs_DpIntrHandler -
XDpRxSs_HdcpIntrHandler - XDpRxSs_TmrCtrIntrHandler, for handling the interrupt
from the DisplayPort, optional HDCP and Timer Counter sub-cores respectively.
The users of this driver have to register this handler with the interrupt system
and provide the callback functions by using XDpRxSs_SetCallBack API. <b>Virtual
Memory</b> This driver supports Virtual Memory. The RTOS is responsible for
calculating the correct device base address in Virtual Memory space.
<b>Threads</b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by defining
at compile time, the NDEBUG identifier. By default, asserts are turned on and it
is recommended that users leave asserts on during development. <b>Building the
driver</b> The DisplayPort Receiver Subsystem driver is composed of several
source files. This allows the user to build and link only those parts of the
driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----
--- -------- 1.00 sha 05/18/15 Initial release. 2.00 sha 10/05/15 Removed HDCP
interrupt handler types. Added HDCP and Timer Counter support. 3.0 sha 02/19/16
Removed indexing from enum XDpRxSs_HandlerType. Added handler type as enum for
HDCP: XDPRXSS_HANDLER_HDCP_RPTR_TDSA_EVENT. Added function:
XDpRxSs_DownstreamReady. 3.1 als 08/08/16 Added HDCP timeout functionality. 3.1
aad 09/07/16 Updates to support 64-bit base addresses. 4.0 aad 12/01/16 Added
interrupt handler for HDCP authentication ms 01/23/17 Modified xil_printf
statement in main function for all examples to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 03/17/17 Modified readme.txt file in examples folder for doxygen generation.
4.1 tu 09/08/17 Added three driver side interrupt handler for Video, NoVideo and
PowerChange events </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dbg.c @addtogroup
dprxss_v4_0 @{ This file contains functions to report debug information of
DisplayPort RX Subsystem sub-cores. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 05/18/15 Initial release. 2.00 sha 10/05/15
Added HDCP support. Removed DP159 bit error count code. Used DP159 bit error
count function from Video Common library. 4.00 aad 11/14/16 Modified to use
DP159 from dprxss 4.01 aad 07/06/17 Added MAUD and NAUD to MSA prints. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_dbg.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dp159.c @addtogroup
dprxss_v4_0 @{ This file contains a set of functions to configure the DP159.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha
07/13/15 Initial release. 1.00 sha 08/11/15 Removed extra DP159 register
programming as per new DP159 programming guide. Added bit error count function.
2.2 als 02/01/16 Functions with pointer arguments that don't modify contents now
const. 3.0 aad 05/13/16 Added bus busy check before I2C reads and writes. 3.1
als 08/03/16 Reordered wait for PLL lock. 4.0 aad 11/15/16 Moved to dprxss
driver from video_common 4.0 aad 07/13/17 Updated DP159 read lock status </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_dp159.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dp159.h @addtogroup
dprxss_v4_0 @{ This is the header file contains macros, enum, structure and
function prototypes for DP159. <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- --- -------- 1.00 sha 07/13/15 Initial release. 1.00 sha 08/11/15 Modified
XDPRXSS_DP159_CT_PWR -> XDPRXSS_DP159_CT_UNPLUG. Added bit error count function.
2.2 als 02/01/16 Functions with pointer arguments that don't modify contents now
const. 3.1 aad 06/16/16 Updated CPI pull down HBR2 value 4.0 aad 11/15/16 Moved
to dprxss form video_common </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_dp159.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_hw.h @addtogroup
dprxss_v4_0 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx DisplayPort Receiver
Subsystem. For more information about the operation of this core see the
hardware specification and documentation in the higher level driver xdprxss.h
file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00
sha 05/18/15 Initial release. 2.00 sha 10/05/15 Added Timer Counter reset value
macro. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_intr.c @addtogroup
dprxss_v4_1 @{ This file contains interrupt related functions of Xilinx
DisplayPort RX Subsystem core. Please see xdprxss.h for more details of the
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00
sha 05/18/15 Initial release. 2.00 sha 10/05/15 Removed setting HDCP callbacks.
Added HDCP and Timer Counter interrupt handler. 3.0 sha 02/19/16 Added switch
case for XDPRXSS_HANDLER_HDCP_RPTR_TDSA_EVENT to register callback with HDCP.
4.0 aad 12/01/16 Added HDCP Authentication interrupt handler 4.1 tu 09/06/17
Added three driver side interrupt handler for Video, NoVideo and PowerChange
event </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_selftest.c @addtogroup
dprxss_v4_0 @{ This file contains self test function for the DisplayPort
Receiver Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----
--- -------- 1.00 sha 05/18/15 Initial release. 2.00 sha 10/05/15 Added HDCP and
Timer Counter self test. 4.00 tu 25/06/17 Added proper return value </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_sinit.c @addtogroup
dprxss_v4_0 @{ This file contains static initialization method for Xilinx
DisplayPort Receiver Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 05/18/15 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/xdprxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dprx.c This file
contains a minimal set of functions for the DisplayPort core to configure. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 05/18/15
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/dp/xdprxss_dprx.c
XilinxProcessorIPLib/drivers/dp14rxss/src/dp/xdprxss_dprx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dprx.h This is the
header file for Xilinx DisplayPort Receiver Subsystem sub-core, is DisplayPort.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha
05/18/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/dp/xdprxss_dprx.h
XilinxProcessorIPLib/drivers/dp14rxss/src/dp/xdprxss_dprx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_hdcp1x.c This file
contains a minimal set of functions for the High-Bandwidth Content Protection
core to configure. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 05/18/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/hdcp1x/xdprxss_hdcp1x.c
XilinxProcessorIPLib/drivers/dp14rxss/src/hdcp1x/xdprxss_hdcp1x.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_hdcp1x.h This is the
header file for Xilinx DisplayPort Receiver Subsystem sub-core, is High-
Bandwidth Content Protection (HDCP). <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 05/18/15 Initial release. 2.00 sha 10/05/15
Protected HDCP, Timer Counter header file under macro number of instances.
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/hdcp1x/xdprxss_hdcp1x.h
XilinxProcessorIPLib/drivers/dp14rxss/src/hdcp1x/xdprxss_hdcp1x.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_iic.c This file
contains a minimal set of functions for the IIC core to configure. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 05/18/15
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/iic/xdprxss_iic.c
XilinxProcessorIPLib/drivers/dp14rxss/src/iic/xdprxss_iic.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_iic.h This is the
header file for Xilinx DisplayPort Receiver Subsystem sub-core, is IIC. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 05/18/15
Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12rxss/src/iic/xdprxss_iic.h
XilinxProcessorIPLib/drivers/dp14rxss/src/iic/xdprxss_iic.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"),to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 2.00 sha 08/07/15 Added HDCP support to work with DP
pass-through. 2.00 sha 09/28/15 Added Timer Counter support to work with DP
pass-through. 3.0 sha 02/05/16 Added support to generate XPAR_ parameters for
multiple subsystems in a design.

FILES:
XilinxProcessorIPLib/drivers/dp12txss/data/dp12txss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_debug_example.c This
file contains a design example using the XDpTxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode and provides DisplayPort
Subsystem debug information at runtime. @note For this example to display
output, the user need to implement initialization of the system
(DpTxSs_PlatformInit) and after DisplayPort TX subsystem start (XDpTxSs_Start)
is complete, implement configuration of the video stream source in order to
provide the DisplayPort TX Subsystem HIP input. The functions
DpTxSs_PlatformInit and DpTxSs_StreamSrc are declared and are left up to the
user implement. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 07/01/15 Initial release. 2.00 sha 09/28/15 Added HDCP debug
info function call. 4.1 ms 01/23/17 Modified xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/examples/xdptxss_debug_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/xdptxss_debug_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_hdcp_example.c This
file contains a design example using the XDpTxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode and enables HDCP. @note For this
example to display output, the user need to implement initialization of the
system (DpTxSs_PlatformInit) and after DisplayPort TX subsystem start
(XDpTxSs_Start) is complete, implement configuration of the video stream source
in order to provide the DisplayPort TX Subsystem HIP input. The functions
DpTxSs_PlatformInit and DpTxSs_StreamSrc are declared and are left up to the
user implement. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 2.00 sha 09/28/15 Initial release. 4.1 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/examples/xdptxss_hdcp_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/xdptxss_hdcp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_intr_example.c This
file contains a design example using the XDpTxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode with interrupts. Upon Hot-Plug-
Detect (HPD - DisplayPort cable is plugged/unplugged or the monitor is turned
on/off), DisplayPort TX Subsystem will read the capability of RX device and re-
start the subsystem. @note This example requires an interrupt controller
connected to the processor and the DisplayPort TX Subsystem HIP in the system.
For this example to display output, the user need to implement initialization of
the system (DpTxSs_PlatformInit) and after DisplayPort TX subsystem start
(XDpTxSs_Start) is complete, implement configuration of the video stream source
in order to provide the DisplayPort TX Subsystem HIP input. The functions
DpTxSs_PlatformInit and DpTxSs_StreamSrc are declared and are left up to the
user implement. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 07/01/15 Initial release. 2.00 sha 09/28/15 Added HDCP, Timer
Counter interrupt handier registration. Added set MSA callback. 4.1 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/examples/xdptxss_intr_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/xdptxss_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_mst_example.c This file
contains a design example using the XDpTxSs driver in single stream (SST)
transport or multi-stream transport (MST) mode. @note For this example to
display output, the user need to implement initialization of the system
(DpTxSs_PlatformInit) and after DisplayPort TX subsystem start (XDpTxSs_Start)
is complete, implement configuration of the video stream source in order to
provide the DisplayPort TX Subsystem HIP input. The functions
DpTxSs_PlatformInit and DpTxSs_StreamSrc are declared and are left up to the
user implement. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 07/01/15 Initial release. 4.1 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/examples/xdptxss_mst_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/xdptxss_mst_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_selftest_example.c This
file contains a design example using the XDpTxSs driver. It performs a self test
on the DisplayPort Transmitter Subsystem Hierarchical IP that will test its sub-
cores self test functions. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 07/01/15 Initial release. 4.1 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/examples/xdptxss_selftest_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/xdptxss_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- --- -------- 1.00 KI 07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12txss/examples/src/zcu_tx/LMK04906.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/zcu_tx/clk_set.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/zcu_tx/menus.c
XilinxProcessorIPLib/drivers/dp12txss/examples/src/zcu_tx/xdptxss_zcu102_tx.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/clk_set.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/menus.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/xdptxss_zcu102_tx.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/tx.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/tx.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/menus.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/xdprxss_zcu102_dp14_pt_mst.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/clk_set.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/menus.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/xdptxss_zcu102_tx.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/menus.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/xdptxss_vcu118_dp14_tx.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/tx.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/tx.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/menus.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/xdptxss_zcu102_dp14_tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss.c @addtogroup
dptxss_v5_0 @{ This is the main file for Xilinx DisplayPort Transmitter
Subsystem driver. This file contains a minimal set of functions for the XDpTxSs
driver that allow access to all of the DisplayPort Transmitter Subsystem core's
functionality. Please see xdptxss.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 01/29/15
Initial release. 1.00 sha 07/21/15 Renamed sub-cores functions with prefix
XDpTxSs_ 2.00 sha 08/07/15 Added support for customized main stream attributes.
Added HDCP instance into global sub-cores structure. 2.00 sha 09/28/15 Added
HDCP and Timer Counter support. 3.0 sha 02/05/16 Added support for multiple
subsystems in a design. 3.0 sha 02/19/16 Added function: XDpTxSs_ReadDownstream,
XDpTxSs_HandleTimeout. Enabled HDCP in XDpTxSs_Start function. 4.1 aad 07/28/16
Enabled VTC before DPTX core enable for better image stability 4.1 als 08/08/16
Synchronize with new HDCP APIs. aad 09/06/16 Updates to support 64-bit base
address 5.0 tu 07/20/17 Allowing Custom VTM in XDpTxSs_SetVidMode function. 5.0
tu 08/10/17 Adjusted BS symbol for equal timing 5.0 tu 08/11/17 Removing ceil()
to remove dependency on math library. 5.0 tu 09/06/17 Set timer callback after
HDCP initialization 5.0 tu 09/06/17 Added Set UserPixelWidth support on tx side
5.0 tu 09/08/17 Set HPD callbacks for HPD event and HPD pulse </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss.h @addtogroup
dptxss_v5_0 @{ @details This is the main header file for Xilinx DisplayPort
Transmitter Subsystem core. It abstracts Subsystem cores and provides high level
API's to application developer. <b>Core Features</b> For a full description of
DisplayPort Transmitter Subsystem core, please see the hardware specification.
<b>Software Initialization & Configuration</b> The application needs to do
following steps in order for preparing the DisplayPort Transmitter Subsystem
core to be ready. - Call XDpTxSs_LookupConfig using a device ID to find the core
configuration. - Call XDpTxSs_CfgInitialize to initialize the device and the
driver instance associated with it. <b>Interrupts</b> The DisplayPort TX
Subsystem driver provides the interrupt handlers - XDpTxSs_DpIntrHandler -
XDpTxSs_HdcpIntrHandler - XDpTxSs_TmrCtrIntrHandler, for handling the interrupt
from the DisplayPort, optional HDCP and Timer Counter sub-cores respectively.
The users of this driver have to register this handler with the interrupt system
and provide the callback functions by using XDpTxSs_SetCallBack API. <b>Virtual
Memory</b> This driver supports Virtual Memory. The RTOS is responsible for
calculating the correct device base address in Virtual Memory space.
<b>Threads</b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by defining
at compile time, the NDEBUG identifier. By default, asserts are turned on and it
is recommended that users leave asserts on during development. <b>Building the
driver</b> The DisplayPort Transmitter Subsystem driver is composed of several
source files. This allows the user to build and link only those parts of the
driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----
--- -------- 1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15 Included
renamed sub-cores header files. 2.00 sha 08/07/15 Added new handler types: lane
count, link rate, pre-emphasis voltage swing adjust and set MSA. Added support
for customized main stream attributes. Added function:
XDpTxSs_SetHasRedriverInPath. Added HDCP support data structure. 2.00 sha
09/28/15 Added HDCP and Timer Counter functions. 3.0 sha 02/19/16 Added handler
type as enums for HDCP: XDPTXSS_HANDLER_HDCP_RPTR_DWN_STRM_RDY,
XDPTXSS_HANDLER_HDCP_RPTR_EXCHG. Added function: XDpTxSs_ReadDownstream,
XDpTxSs_HandleTimeout. 4.0 aad 05/13/16 Expose API to set (a)synchronous clock
mode from DP driver. 4.1 als 08/08/16 Synchronize with new HDCP APIs. aad
09/06/16 Updates to support 64-bit base addresses. ms 01/23/17 Modified
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Modified readme.txt file in examples folder for
doxygen generation. 5.0 tu 08/10/17 Adjusted BS symbol for equal timing 5.0 tu
09/08/17 Added two interrupt handler that addresses driver's internal callback
function of application DrvHpdEventHandler and DrvHpdPulseHandler Added HPD user
data stucture XDpTxSs_UsrHpdPulseData and XDpTxSs_UsrHpdEventData </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_dbg.c @addtogroup
dptxss_v5_0 @{ This file contains functions to report debug information of
DisplayPort TX Subsystem sub-cores. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 01/29/15 Initial release. 2.00 sha 08/07/15
Updated register offsets in debug MSA info. 2.00 sha 09/28/15 Added HDCP debug
function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss_dbg.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_hw.h @addtogroup
dptxss_v5_0 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx DisplayPort
Transmitter Subsystem core. For more information about the operation of this
core see the hardware specification and documentation in the higher level driver
xdptxss.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 01/29/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_intr.c @addtogroup
dptxss_v5_0 @{ This file contains interrupt related functions of Xilinx
DisplayPort TX Subsystem core. Please see xdptxss.h for more details of the
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00
sha 01/29/15 Initial release. 2.00 sha 08/07/15 Added new handler types: lane
count, link rate, Pre-emphasis voltage swing adjust and Set MSA. 2.00 sha
09/28/15 Added HDCP and Timer Counter interrupt handlers. 3.0 sha 02/19/16 Added
switch cases for XDPTXSS_HANDLER_HDCP_RPTR_DWN_STRM_RDY and
XDPTXSS_HANDLER_HDCP_RPTR_EXCHG to register callback with HDCP. 4.1 als 08/08/16
Synchronize with new HDCP APIs. 5.0 tu 09/08/17 Added two interrupt handler that
addresses driver's internal callback function of application DrvHpdEventHandler
and DrvHpdPulseHandler </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_selftest.c @addtogroup
dptxss_v5_0 @{ This file contains self test function for the DisplayPort
Transmitter Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- --- -------- 1.00 sha 01/29/15 Initial release. 2.00 sha 09/28/15 Added
HDCP and Timer Counter self test. 4.1 tu 25/06/17 Added return values </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_sinit.c @addtogroup
dptxss_v5_0 @{ This file contains static initialization method for Xilinx
DisplayPort Transmitter Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 01/29/15 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/xdptxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_dptx.c This file
contains a minimal set of functions for the DisplayPort core to configure in TX
mode of operation. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15 Renamed file name
with prefix xdptxss_ and function names with prefix XDpTxSs_. 2.00 sha 08/07/15
Added support for customized main stream attributes for Single Steam Transport
and Multi-Stream Transport. 2.00 sha 09/28/15 Removed cross checking user set
resolution with RX EDID. 4.0 aad 05/13/16 Use asynchronous clock mode by
default. 5.0 tu 08/03/17 Enabled video packing for bpc > 10 5.0 aad 09/08/17
Case to handle HTotal > 4095, PPC 1 in AXIStream Mode. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/dp/xdptxss_dptx.c
XilinxProcessorIPLib/drivers/dp14txss/src/dp/xdptxss_dptx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_dptx.h This is the
header file for Xilinx DisplayPort Transmitter Subsystem sub-core, is
DisplayPort in TX mode of operation. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15
Renamed file name with prefix xdptxss_, function names with prefix XDpTxSs_ and
macros with prefix XDPTXSS_ </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/dp/xdptxss_dptx.h
XilinxProcessorIPLib/drivers/dp14txss/src/dp/xdptxss_dptx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_dualsplitter.c This
file contains a minimal set of functions for the Dual Splitter core to
configure. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- --------
1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15 Renamed file name with
prefix xdptxss_ and function name with prefix XDpTxSs_. 2.00 sha 08/07/15
Removed video mode check. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/dualsplitter/xdptxss_dualsplitter.c
XilinxProcessorIPLib/drivers/dp14txss/src/dualsplitter/xdptxss_dualsplitter.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xss_dualsplitter.h This is the
header file for Xilinx DisplayPort Transmitter Subsystem sub-core, is Dual
Splitter. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- --------
1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15 Renamed file name with
prefix xdptxss_ and function name with prefix XDpTxSs_ </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/dualsplitter/xdptxss_dualsplitter.h
XilinxProcessorIPLib/drivers/dp14txss/src/dualsplitter/xdptxss_dualsplitter.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_hdcp1x.c This file
contains a minimal set of functions for the High-Bandwidth Content Protection
core to configure. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 2.00 sha 09/28/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/hdcp1x/xdptxss_hdcp1x.c
XilinxProcessorIPLib/drivers/dp14txss/src/hdcp1x/xdptxss_hdcp1x.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_hdcp1x.h This is the
header file for Xilinx DisplayPort Transmitter Subsystem sub-core, is High-
Bandwidth Content Protection (HDCP). <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 2.00 sha 09/28/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/hdcp1x/xdptxss_hdcp1x.h
XilinxProcessorIPLib/drivers/dp14txss/src/hdcp1x/xdptxss_hdcp1x.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_vtc.c This file
contains a minimal set of functions for the Video Timing controller core to
configure. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- --------
1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15 Renamed file name with
prefix xdptxss_ and function name with prefix XDpTxSs_ 2.00 sha 08/07/15 Set
interlace to zero when video mode is XVIDC_VM_CUSTOM. 4.1 als 08/03/16 Use video
common API rather than internal structure when checking for interlaced mode. 5.0
tu 08/10/17 Adjusted BS symbol for equal timing </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/vtc/xdptxss_vtc.c
XilinxProcessorIPLib/drivers/dp14txss/src/vtc/xdptxss_vtc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_vtc.h This is the
header file for Xilinx DisplayPort Transmitter Subsystem sub-core, is Video
Timing Controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15 Renamed file name
with prefix xdptxss_ and function name with prefix XDpTxSs_ 5.0 tu 08/10/17
Modified XDpTxSs_VtcSetup for adjusting BS symbol for equal timing </pre>

FILES:
XilinxProcessorIPLib/drivers/dp12txss/src/vtc/xdptxss_vtc.h
XilinxProcessorIPLib/drivers/dp14txss/src/vtc/xdptxss_vtc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp.c @addtogroup dp_v7_0 @{
Contains a minimal set of functions for the XDp driver that allow access to all
of the DisplayPort core's functionality. See xdp.h for a detailed description of
the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 als 01/20/15 Initial release. TX code merged from the dptx
driver. 2.0 als 06/08/15 Updated RX initialization with MST support. Added
callbacks for lane count changes, link rate changes and pre-emphasis + voltage
swing adjust requests. 5.1 als 08/09/16 Replaced deprecated MB_Sleep with
consolidated usleep. 08/11/16 RX to support maximum pre-emphasis level of 1.
08/12/16 Updates to support 64-bit base addresses. 5.2 aad 01/21/17 Added
training timeout disable for RX MST mode for soft-disconnect to work. 6.0 tu
05/14/17 Added AUX defer to 6 6.0 jb 02/19/19 Added HDCP22 functions. 02/21/19
Added returning AUX defers for HDCP22 DPCD offsets </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp.h @addtogroup dp_v7_0 @{
@details The Xilinx DisplayPort transmitter (DP) driver. This driver supports
the Xilinx DisplayPort soft IP core in both transmit/source (TX) and
receive/sink (RX) modes of operation. The Xilinx DisplayPort soft IP supports
the following features: - 1, 2, or 4 lanes. - A link rate of 1.62, 2.70, or
5.40Gbps per lane. - 1, 2, or 4 pixel-wide video interfaces. - RGB and YCbCr
color space. - Up to 16 bits per component. - Up to 4Kx2K monitor resolution. -
Auto lane rate and width negotiation. - I2C over a 1Mb/s AUX channel. -
Secondary channel audio support (2 channels). - 4 independent video multi-
streams. The Xilinx DisplayPort soft IP does not support the following features:
- The automated test feature. - Audio (3-8 channel). - FAUX. - Bridging
function. - MST audio. - eDP optional features. - iDP. - GTC. <b>DisplayPort
overview</b> A DisplayPort link consists of: - A unidirectional main link which
is used to transport isochronous data streams such as video and audio. The main
link may use 1, 2, or 4 lanes at a link rate of 1.62, 2.70, or 5.40Gbps per
lane. The link needs to be trained prior to sending streams. - An auxiliary
(AUX) channel is a 1MBps bidirectional channel used for link training, link
management, and device control. - A hot-plug-detect (HPD) signal line is used to
determine whether a DisplayPort connection exists between the DisplayPort TX
connector and an RX device. It is serves as an interrupt request by the RX
device. <b>Device configuration</b> The device can be configured in various ways
during the FPGA implementation process. Configuration parameters are stored in
the xdp_g.c file which is generated when compiling the board support package
(BSP). A table is defined where each entry contains configuration information
for the DisplayPort instances present in the system. This information includes
parameters that are defined in the driver's data/dp.tcl file such as the base
address of the memory-mapped device and the maximum number of lanes, maximum
link rate, and video interface that the DisplayPort instance supports, among
others. The DisplayPort core may be configured in both transmitter (TX) or
receiver (RX) modes of operation. Depending on which mode of operation the
hardware is configured for, the set of registers associated with the core will
be different. <b>Driver description</b> The DisplayPort (DP) driver consists of
functions, structures, and definitions: 1) Specific to the DisplayPort TX mode
of operation. - Prefix: XDp_Tx and XDP_TX_ 2) Specific to the DisplayPort RX
mode of operation. - Prefix: XDp_Rx and XDP_RX_ 3) Common to both DisplayPort
modes of operation. - Prefix: XDp_ and XDP_ <b>Driver description: TX mode of
operation</b> The device driver enables higher-level software (e.g., an
application) to configure and control a DisplayPort TX soft IP, communicate and
control an RX device/sink monitor over the AUX channel, and to initialize and
transmit data streams over the main link. This driver follows the DisplayPort
1.2a specification. This driver implements link layer functionality: a Link
Policy Maker (LPM) and a Stream Policy Maker (SPM) as per the DisplayPort 1.2a
specification. - The LPM manages the main link and is responsible for keeping
the link synchronized. It will establish a link with a downstream RX device by
undergoing a link training sequence which consists of: - Clock recovery: The
clock needs to be recovered and PLLs need to be locked for all lanes. - Channel
equalization: All lanes need to achieve channel equalization and and symbol
lock, as well as for interlane alignment to take place. - The SPM manages
transportation of an isochronous stream. That is, it will initialize and
maintain a video stream, establish a virtual channel to a sink monitor, and
transmit the stream. Using AUX transactions to read/write from/to the sink's
DisplayPort Configuration Data (DPCD) address space, the LPM obtains the link
capabilities, obtains link configuration and link and sink status, and
configures and controls the link and sink. The main link is trained this way.
I2C-over-AUX transactions are used to obtain the sink's Extended Display
Identification Data (EDID) which give information on the display capabilities of
the monitor. The SPM may use this information to determine what available screen
resolutions and video timing are possible. <b>Driver description: RX mode of
operation</b> The device driver enables higher-level software (e.g., an
application) to configure and control a DisplayPort RX soft IP. This driver
gives applications the ability to configure the RX using various settings,
handle and issue interrupts, and modify a subset of its DisplayPort
Configuration Data (DPCD) fields. Link training is done automatically by the
hardware. <b>Interrupt processing</b> For the driver to process interrupts, the
application must set up the system's interrupt controller and connect the
XDp_InterruptHandler function to service interrupts. When an interrupt occurs,
XDp_InterruptHandler will check which mode of operation the DisplayPort core is
running in, and will call the appropriate interrupt handler for that core
(XDp_TxInterruptHandler or XDp_RxInterruptHandler - local to xdp_intr.c).
<b>Interrupt processing: TX mode of operation</b> DisplayPort interrupts occur
on the HPD signal line when the DisplayPort cable is connected/disconnected or
when the RX device sends a pulse. The user hardware design must contain an
interrupt controller which the DisplayPort TX instance's interrupt signal is
connected to. The user application must enable interrupts in the system and set
up the interrupt controller such that the XDp_TxHpdInterruptHandler handler will
service DisplayPort interrupts. When the XDp_TxHpdInterruptHandler function is
invoked, the handler will identify what type of DisplayPort interrupt has
occurred, and will call either the HPD event handler function or the HPD pulse
handler function, depending on whether a an HPD event on an HPD pulse event
occurred. The DisplayPort TX's XDP_TX_INTERRUPT_STATUS register indicates the
type of interrupt that has occurred, and the XDp_TxInterruptHandler will use
this information to decide which handler to call. An HPD event is identified if
bit XDP_TX_INTERRUPT_STATUS_HPD_EVENT_MASK is set, and an HPD pulse is
identified from the XDP_TX_INTERRUPT_STATUS_HPD_PULSE_DETECTED_MASK bit. The HPD
event and HPD pulse handler may be set up by using the XDp_TxSetCallback
function and XDP_TX_HANDLER_HPDEVENT and XDP_TX_HANDLER_HPDPULSE enumerations of
the XDp_Tx_HandlerType type. <b>Interrupt processing: RX mode of operation</b>
The DisplayPort RX driver may generate a pulse on the hot-plug-detect (HPD)
signal line using the XDp_RxGenerateHpdInterrupt function. This allows the RX to
send an interrupt to the upstream TX device, useful for signaling the TX that it
needs to do some checks for changes in downstream devices or a loss of link
training. For RX interrupt handling of HPD events or events that happen internal
to the RX, the user hardware design must contain an interrupt controller which
the DisplayPort RX instance's interrupt signal is connected to. The user
application must enable interrupts in the system and set up the interrupt
controller such that the XDp_RxInterruptHandler handler will service interrupts.
When the XDp_RxInterruptHandler function is invoked, the handler will identify
what type of interrupt has occurred, and will call the appropriate interrupt
handler. The DisplayPort RX's XDP_RX_INTERRUPT_CAUSE register indicates the type
of interrupt that has occured, and the XDp_RxInterruptHandler will use this
information to decide which handler to call. The handlers are set up using the
XDp_RxSetIntr functions. Specific interrupts may be enabled or disabled using
the XDp_RxInterruptEnable and XDp_RxInterruptDisable functions. <b>Multi-stream
transport (MST) mode: TX mode of operation</b> The driver handles MST mode
functionality in TX mode of operation, including sideband messaging, topology
discovery, virtual channel payload ID table management, and directing streams to
different sinks. MST testing has been done at all possible link rate/lane
count/topology/ resolution/color depth combinations with each setting using
following values: - Link rate: 1.62, 2.70, and 5.40Gbps per lane. - Lane count:
1, 2, and 4 lanes. - Number of sink displays: 1, 2, 3, and 4 sink displays in
both a daisy-chain configuration and in a configuration using a combination of a
1-to-3 hub and daisy-chain. Each stream was using the same resolution. -
Resolutions (60Hz): 640x480, 800x600, 1024x768, 1280x800, 1280x1024, 1360x768,
1400x1050, 1680x1050, 1920x1080, 1920x2160, and 3840x2160. - Color depths: 18,
24, 30, 36, and 48 bits per pixel. <b>Multi-stream transport (MST) mode: RX mode
of operation</b> The driver handles MST mode functionality in RX mode of
operation. The API function, XDp_RxHandleDownReq, will read a sideband message
from the down request registers in the DisplayPort RX core, parse it, arbitrate
control for the sideband message type that was requested, format a reply, and
send the reply. The current version of the driver only supports a software
representation of a shallow topology - meaning virtual sinks are defined in the
user application and assigned to port numbers. The RX acts as a branch connected
to multiple sinks, but is not connected to another branch. Sideband messages
will then be handled for the targeted downstream sink. The user application
creates the topology using the driver's API functions: - XDp_RxSetIicMapEntry :
Used to specify the I2C contents of a virtual sink. - XDp_RxSetDpcdMap : Used to
specify the DPCD of a virtual sink. - XDp_RxMstSetPbn : Used to specify the
available PBN of a virtual sink. - XDp_RxMstSetPort : Used to specify how the
sink will appear when the an upstream device sends a LINK_ADDRESS sideband
request to the RX branch. - XDp_RxMstSetInputPort : Used to specify the input
port. - XDp_RxMstExposePort : Used to enable the port by exposing it to incoming
LINK_ADDRESS sideband requests. The driver will keep track of the topology in
the structures: - XDp_RxTopology : Stores topology information as a reply to
LINK_ADDRESS requests, the virtual channel payload table, and port
representations (XDp_RxPort[] type). - XDp_RxPort : Stores the I2C map
(XDp_RxIicMapEntry[] type), DPCD address space (XDp_RxDpcdMap type), PBN
information, and whether or not the represented sink is exposed to upstream
devices. - XDp_RxIicMapEntry : Represents data stored at an associated I2C
address. - XDp_RxDpcdMap : Represents the DPCD of an associated port's sink.
Note that the driver uses the topology's XDp_RxPort[] array such that the
indices match the port number that attaches the virtual sink to the RX branch.
The following sideband messages are supported: - CLEAR_PAYLOAD_ID_TABLE -
LINK_ADDRESS - REMOTE_I2C_READ - REMOTE_DPCD_READ - ENUM_PATH_RESOURCES -
ALLOCATE_PAYLOAD Other sideband messages are replied to with NACK. <b>Audio</b>
The driver in RX mode of operation may received audio info and extension
packets. When this happens, if interrupts are enabled, the appropriate handlers
will be invoked. Control functions are available for enabling, disabling, and
resetting audio in the DisplayPort RX core. The TX driver does not handle audio.
For an example as to how to configure and transmit audio,
examples/xdptx_audio_example.c illustrates the required sequence in the TX mode
of operation. The user will need to configure the audio source connected to the
Displayport TX instance and set up the audio info frame as per user
requirements. <b>Asserts</b> Asserts are used within all Xilinx drivers to
enforce constraints on argument values. Asserts can be turned off on a system-
wide basis by defining, at compile time, the NDEBUG identifier. By default,
asserts are turned on and it is recommended that application developers leave
asserts on during development. <b>Limitations: TX mode of operation</b> - For
MST mode to correctly display, the current version of the driver requires that
each of the DisplayPort TX streams be allocated without skipping streams (i.e.
assign stream 1, stream 2, and stream 3 - problems were experienced if skipping
stream 2 and assigning stream 4 instead). skipping monitors in a daisy chain is
OK as long as they are assigned to streams in order. - In MST mode, the current
version of the driver does not support removal of an allocated stream from the
virtual channel payload ID table without clearing the entire table. - Some
sideband messages have not been implemented in the current version of the driver
for MST mode. Notably, reception of a CONNECTION_STATUS_NOTIFY sideband message.
- The driver does not handle audio. See the audio example in the driver examples
directory for the required sequence for enabling audio. <b>Limitations: RX mode
of operation</b> - Sideband messages that aren't supported as specified above
will be NACK'ed. @note For a 5.4Gbps link rate, a high performance 7 series FPGA
is required with a speed grade of -2 or -3. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 als 01/20/15 Initial release. TX code
merged from the dptx driver. 2.0 als 06/08/15 Added MST functionality to RX. New
APIs: XDp_RxHandleDownReq, XDp_RxGetIicMapEntry, XDp_RxSetIicMapEntry,
XDp_RxSetDpcdMap, XDp_RxMstExposePort, XDp_RxMstSetPort, XDp_RxMstSetInputPort,
XDp_RxMstSetPbn, XDp_RxSetIntrDownReqHandler, XDp_RxSetIntrDownReplyHandler,
XDp_RxSetIntrAudioOverHandler, XDp_RxSetIntrPayloadAllocHandler,
XDp_RxSetIntrActRxHandler, XDp_RxSetIntrCrcTestHandler Added IntrHandler and
IntrCallbackRef interrupt-related members to XDp_Rx structure for: DownReq,
DownReply, AudioOver, PayloadAlloc, ActRx, CrcTest Added new data structures
related to RX MST topology: XDp_RxIicMapEntry, XDp_RxDpcdMap, XDp_RxPort,
XDp_RxTopology Renamed XDp_Tx to XDp_ to reflect commonality with RX for:
XDp_TxSbMsgLinkAddressReplyPortDetail XDp_TxSbMsgLinkAddressReplyDeviceInfo GUID
type change for ease of use: 'u32 Guid[4]' changed to 'u8 Guid[16]' Added
handlers and setter functions for HDCP and unplug events. Added callbacks for
lane count changes, link rate changes and pre-emphasis + voltage swing adjust
requests. 3.0 als 10/07/15 Added MSA callback. 4.0 als 12/08/15 Added link rate
and lane count validity check APIs: XDp_IsLinkRateValid XDp_IsLaneCountValid
XDp_TxAllocatePayloadVcIdTable now takes an additional argument (StartTs, the
starting timeslot). Added RX API to get color depth of a given stream.
XDp_RxGetBpc Added RX API to get color component format of a stream.
XDp_RxGetColorComponent Added RX API to set end of line reset as appropriate.
XDp_RxSetLineReset Added RX MST API to allocate payload from ISR:
XDp_RxAllocatePayloadStream 5.0 als 05/16/16 Added APIs to set color encoding
scheme. 5.1 als 08/12/16 Updates to support 64-bit base addresses. ms 01/23/17
Added xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Modified readme.txt file in examples folder for
doxygen generation. 5.3 ms 04/18/17 Modified tcl file to add suffix U for all
macros definitions of dp in xparameters.h 6.0 tu 09/08/17 Added two interrupt
handler that addresses driver's internal callback function of application
DrvHpdEventHandler and DrvHpdPulseHandler 6.0 tu 09/08/17 Added three interrupt
handler that addresses callback function of driver 6.0 jb 02/19/19 Added
IntrHandler and IntrCallbackRef interrupt-related members to XDp_Rx structure
for: Hdcp22AkeInitWr, Hdcp22AkeNoStoredKmWr, Hdcp22AkeStoredWr, Hdcp22LcInitWr,
Hdcp22SkeSendEksWr, Hdcp22LinkIntegrityFail, Hdcp22HprimeReadDone,
Hdcp22PairingReadDone Added new HDCP22 functions: XDp_GenerateCpIrq,
XDp_EnableDisableHdcp22AuxDeffers </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_edid.c @addtogroup dp_v7_0
@{ This file contains functions related to accessing the Extended Display
Identification Data (EDID) of a specified sink using the XDp driver operating in
TX mode. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 01/20/15 Initial release. TX code merged from the dptx driver.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp_edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_hw.h @addtogroup dp_v7_0 @{
This header file contains the identifiers and low-level driver functions (or
macros) that can be used to access the device. High-level driver functions are
defined in xdp.h. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 als 01/20/15 Initial release. TX code merged from the
dptx driver. 2.0 als 06/08/15 Added MST registers, masks, and values for RX.
Added HDCP registers and masks. 5.0 als 05/16/16 Added MISC0 and MISC1
definitions. 5.1 aad 08/16/16 Updated MISC0 definitions. 5.2 aad 01/21/17 Added
timeout macro for training timeout 6.0 tu 05/14/17 Added AUX defer shift mask
6.0 tu 08/03/17 Enabled video packing for bpc > 10 6.0 tu 08/24/17 Modify define
for YCBCR422 and YCBCR444 6.0 jb 02/19/19 Added HDCP22 registers. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_intr.c @addtogroup dp_v7_0
@{ This file contains functions related to XDp interrupt handling. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als
01/20/15 Initial release. TX code merged from the dptx driver. 2.0 als 06/08/15
Added MST interrupt handlers for RX. Guard against uninitialized callbacks.
Added HDCP interrupts. Added unplug interrupt. 4.0 als 02/18/16 Removed update
of payload table in the driver's interrupt handler. 6.0 tu 05/30/17 Removed
unused variable in XDp_RxInterruptHandler 6.0 tu 09/08/17 Added two interrupt
handler that addresses driver's internal callback function of application
DrvHpdEventHandler and DrvHpdPulseHandler 6.0 tu 09/08/17 Added three interrupt
handler that addresses callback function of application 6.0 jb 02/19/19 Added
HDCP22 interrupts. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_mst.c @addtogroup dp_v7_0
@{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als
01/20/15 Initial release. TX code merged from the dptx driver. 2.0 als 06/08/15
Added MST functionality to RX. 4.0 als 02/16/16 XDp_TxAllocatePayloadStreams now
allocates payloads by using an internally calculated starting timeslot for each
stream rather than invoking XDp_TxGetFirstAvailableTs.
XDp_TxAllocatePayloadVcIdTable now takes an additional argument (StartTs, the
starting timeslot). Exposed RX MST API to application:
XDp_RxAllocatePayloadStream 5.2 aad 01/24/16 XDp_RxAllocatePayloadStream now
adjusts to timeslot rearragement 6.0 tu 05/30/17 Initialized variable in
XDp_RxDeviceInfoToRawData </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp_mst.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_selftest.c @addtogroup
dp_v7_0 @{ This file contains a diagnostic self-test function for the XDp
driver. It will check many of the DisplayPort core's register values against the
default reset values as a sanity-check that the core is ready to be used. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
als 01/20/15 Initial release. TX code merged from the dptx driver. 5.0 als
07/27/16 8B10B enable is now set by default in PHY_CONFIG reg. 6.0 tu 08/04/17
Changed Selftest regiter's default value. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_sinit.c @addtogroup dp_v7_0
@{ This file contains static initialization methods for the XDp driver. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
als 01/20/15 Initial release. TX code merged from the dptx driver. 6.0 tu
02/06/17 Initialize CfgPtr to NULL. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdp_spm.c @addtogroup dp_v7_0
@{ This file contains the stream policy maker functions for the XDp driver.
These functions set up the DisplayPort TX core's main stream attributes (MSA)
that determine how a video stream will be displayed and also some DisplayPort RX
MSA-related functions. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 als 01/20/15 Initial release. TX code merged
from the dptx driver. 2.0 als 07/27/15 Scale TX fractional register by 1024
instead of 1000. 3.0 als 10/07/15 Added MSA callback. 4.0 als 02/07/16
Enable/disable end of line reset for reduced blanking. 5.0 als 05/16/16 Added
API to set color encoding scheme. 5.1 als 08/03/16 Use video common API rather
than internal structure when checking for interlaced mode. als 08/12/16 Updates
to support 64-bit base addresses. 5.2 aad 01/24/17 Disable end of line reset for
reduced blanking 6.0 tu 07/20/17 Allowing Custom VTM in
XDp_TxCfgMsaUseStandardVideoMode function. 6.0 aad 09/05/17 Reverted to enable
end of line reset for RB resolutions. 6.0 tu 09/06/17 Added Set UserPixelWidth
support on tx side </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14/src/xdp_spm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 2.00 sha 10/05/15 Added Timer Counter support. 3.0 sha
02/05/16 Added support to generate XPAR_ parameters for multiple subsystems in a
design. 4.0 tu 27/06/17 Updated parameter AUDIO_CHANNELS name

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/data/dp14rxss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_debug.c This file
provides the implement of the HDCP debug commands <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 07/16/15 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/com/xhdcp1x_debug.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_debug.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/com/xhdcp1x_debug.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_debug.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_debug.h This file
provides the interface of the HDCP debug commands <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 07/16/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/com/xhdcp1x_debug.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_debug.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/com/xhdcp1x_debug.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_example.c This file
provides the implementation of the HDCP example <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.00 07/16/15 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/com/xhdcp1x_example.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/com/xhdcp1x_example.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp_example.h This file
provides the interface of the HDCP example <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 07/16/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/com/xhdcp1x_example.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_example.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/com/xhdcp1x_example.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xhdcp1x_example.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

@file ti_lmk03318.c @addtogroup TI_LMK03318 @{ <pre> Copyright (c) 2016 Adeas
B.V. All rights reserved. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/ti_lmk03318.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/ti_lmk03318.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

@file ti_lmk03318.h @addtogroup TI_LMK03318 @{ <pre> Copyright (c) 2016 Adeas
B.V. All rights reserved. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/ti_lmk03318.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/ti_lmk03318.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

@file videofmc_defs.h @addtogroup VideoFMC @{ <pre> Copyright (c) 2016 Adeas
B.V. All rights reserved. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/dats_dp14/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/dats_dp14/videofmc_defs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file LMK04906.h This file contains
functions to configure Video Pattern Generator core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial release.
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/inc/LMK04906.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/inc/LMK04906.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file PLL_Conf.h This file contains
functions to configure Video Pattern Generator core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial release.
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/inc/PLL_Conf.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/inc/PLL_Conf.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt.h This file contains
functions to configure Video Pattern Generator core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 YB 07/01/15 Initial release.
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/inc/xclk_wiz.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xclk_wiz.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/inc/xclk_wiz.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xclk_wiz.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xedid_print_example.h This file
contains functions to configure Video Pattern Generator core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 YB 07/01/15 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/inc/xedid_print_example.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xedid_print_example.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/inc/xedid_print_example.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xedid_print_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. define SIMULATION

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/inc/xlib_string.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/inc/xlib_string.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dp141.c This file contains
dp141 related functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 Kei 08/12/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/dp141.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/dp141.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt.h This file contains
functions to configure Video Pattern Generator core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial release.
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/dppt.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/dppt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt_vdma.h This file contains
functions to configure Video Pattern Generator core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial release.
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/dppt_vdma.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/dppt_vdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
dppt_vid_phy_config.c This file contains functions to configure Video Pattern
Generator core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 Kei 07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/dppt_vid_phy_config.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/dppt_vid_phy_config.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dppt_vid_phy_config.h This file
contains functions to configure Video Pattern Generator core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 KI 07/13/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/dppt_vid_phy_config.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/dppt_vid_phy_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file edid.c This file contains edid
related functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 Kei 08/12/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/edid.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file idt_8t49n24x.c @addtogroup
IDT_8T49N24x @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported version
from the 8T49N28X-FrequencyProgrammingGuide-register calculations.py script 2.00
MG 16/08/15 Major update 2.10 MG 16/09/05 Added LOS variable </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/idt_8t49n24x.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file idt_8t49n24x.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- X.XX XX
YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported version from the 8T49N28X-
FrequencyProgrammingGuide-register-calculations.py script 2.00 MG 16/08/16 Major
update 2.10 MG 16/09/05 Added LOS variable </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/idt_8t49n24x.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file si570.c This file contains
Si570 related functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 Kei 08/12/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/si570.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/si570.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/si570.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file si_5344.c This file contains
Si5344 related functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 MG 07/27/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/si_5344.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/si_5344.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file si_5344.h <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- X.XX XX YY/MM/DD 1.00 MG
16/07/27 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/si_5344.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/si_5344_freqconfigs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/si_5344.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/si_5344_freqconfigs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ti_lmk03318.c This file
contains VFMC TI LMK03318 related functions. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 RHe 06/20/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/ti_lmk03318.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/ti_lmk03318.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ti_lmk03318.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- X.XX XX
YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/ti_lmk03318.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/ti_lmk03318.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file videofmc_defs.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- X.XX XX
YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/videofmc_defs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_kcu105_dp14.c
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 KI 12/09/17
Initial release.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xdprxss_kcu105_dp14.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xlib_string.c MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 RHe 12/09/17 Initial
release.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xlib_string.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xlib_string.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xlib_string.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 GM 17/07/17
First Release </pre> define SIMULATION

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xlib_string.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xlib_string.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvid_pat_gen.c This file
contains functions to configure Video Pattern Generator core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 shad 01/29/15 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/xvid_pat_gen.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/xvid_pat_gen.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvid_pat_gen.h This is the main
header file for Xilinx Video Pattern Generator. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.00 shad 01/29/15 Initial release.
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xvid_pat_gen.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xvid_pat_gen.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidframe_crc.c This is the
main header file for the Xilinx HDCP abstraction layer. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 GM 17/07/17 First Release
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xvidframe_crc.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/xvidframe_crc.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/xvidframe_crc.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/xvidframe_crc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidframe_crc.h This is the
main header file for the Xilinx HDCP abstraction layer. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 GM 17/07/17 First Release
</pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/kcu_dp14/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xvidframe_crc.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/xvidframe_crc.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/xvidframe_crc.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/xvidframe_crc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Byte-oriented AES-256 implementation.
All lookup tables replaced with 'on the fly' calculations. Copyright (c)
2007-2009 Ilya O. Levin, http://www.literatecode.com Other contributors: Hal
Finney Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above copyright
notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED
"AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT
SHALL AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/aes256.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/aes256.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/aes256.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/aes256.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/aes256.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/aes256.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/aes256.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/aes256.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Variable Definitions /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/eeprom.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/eeprom.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/eeprom.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/eeprom.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. eeprom.h Created on: May 5, 2015
Author: yashova /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/eeprom.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/eeprom.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/eeprom.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/eeprom.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt.c This file contains
the implementation for the key management module. Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt.h This file contains
the interface for the key management module.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_debug.h This file
contains the debug related definitions of the key management software. @note The
contents of this file adjust the definition of the PRINTF and DEBUG_LOG macros
based on the presence/absence of a "FIDUS_BLAZY" definition from within
xparameters.h. It is assumed that is such a definition is present, then the
console infrastructure will be part of the build. Otherwise, the raw Xilinx BSP
functions are called directly.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_debug.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_debug.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_debug.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_device.c This file
contains the implementation for the key management device module. Include Files
/

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_device.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_device.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_device.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_device.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_device.h This file
contains the interface for the key management module.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_device.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_device.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_device.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_device.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_keyfile.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_keyfile.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_keyfile.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_keyfile.c
XilinxProcessorIPLib/drivers/mpegtsmux/src/xmpegtsmux.c
XilinxProcessorIPLib/drivers/sd_fec/src/xsdfec.c
XilinxProcessorIPLib/drivers/v_axi4s_remap/src/xv_axi4s_remap.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_loader.c This file
contains the implementation for the key management loader module. Include Files
/

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_loader.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_loader.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_loader.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_loader.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_loader.h This file
contains the interface for the key management loader module.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_loader.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_loader.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_loader.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_loader.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file keymgmt_testkeys.c This file
contains the table definitions for the four sets of hdcp test keys These keys
are bogus and HDCP will fail with them Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/key/keymgmt_testkeys.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/keymgmt_testkeys.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/key/keymgmt_testkeys.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/keymgmt_testkeys.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file idt_8t49n24x.c @addtogroup
IDT_8T49N24x @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported version
from the 8T49N28X-FrequencyProgrammingGuide-register-calculations.py script 2.00
MG 16/08/15 Major update </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/idt_8t49n24x.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file idt_8t49n24x.h @addtogroup
IDT_8T49N24x @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported version
from the 8T49N28X-FrequencyProgrammingGuide-register-calculations.py script 2.00
MG 16/08/16 Major update </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/idt_8t49n24x.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ti_lmk03318.c @addtogroup
TI_LMK03318 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/ti_lmk03318.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/ti_lmk03318.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/ti_lmk03318.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/ti_lmk03318.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/ti_lmk03318.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/ti_lmk03318.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ti_lmk03318.h @addtogroup
TI_LMK03318 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/ti_lmk03318.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/ti_lmk03318.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/ti_lmk03318.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/ti_lmk03318.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/ti_lmk03318.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/ti_lmk03318.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file videofmc_defs.h @addtogroup
VideoFMC @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/vcu118_dp14_rx/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/videofmc_defs.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/videofmc_defs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file edid.c This file contains edid
related functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 Kei 10/12/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/edid.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/edid.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/edid.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file idt_8t49n24x.c <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- X.XX XX
YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported version from the 8T49N28X-
FrequencyProgrammingGuide-register calculations.py script 2.00 MG 16/08/15 Major
update </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/idt_8t49n24x.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file idt_8t49n24x.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- X.XX XX
YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported version from the 8T49N28X-
FrequencyProgrammingGuide-register calculations.py script 2.00 MG 16/08/16 Major
update </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/idt_8t49n24x.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file main.h This file contains a
design example using the XDpRxSs driver in single stream (SST) transport mode.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 vk
10/04/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/main.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/main.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/main.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/main.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file menus.c This file
contains application menu information. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 KI 07/13/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/menus.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/menus.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/menus.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/menus.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file passthrough.c <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/passthrough.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/passthrough.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/passthrough.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/passthrough.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rx.c <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/rx.c
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/rx.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/rx.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rx.h <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/rx.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/rx.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/rx.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/rx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file tx.h <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/tx.h
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/tx.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/tx.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dptxss_zcu102_pt_dp14.c This
file contains a design example using the XDpSs driver in single stream (SST)
transport mode to demonstrate Pass-through design. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- --- -------- 1.00 KI 04/01/18 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14/xdprxss_zcu102_pt_dp14.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_hdcp/xdptxss_zcu102_dp14_pt_hdcp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_zcu102_pt_dp14.c This
file contains a design example using the XDpSs driver in single stream (SST)
transport mode to demonstrate Pass-through design. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- --- -------- 1.00 KI 04/01/18 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_hdcp/xdprxss_zcu102_dp14_pt_hdcp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file clk_set.c MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 Kei 07/13/17 Initial release.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/clk_set.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/clk_set.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/clk_set.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/clk_set.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file clk_set.h MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 Kei 08/09/17 Initial release.

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/clk_set.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/clk_set.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/clk_set.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/clk_set.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_zcu102_rx.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 Kei 08/09/17
First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_pt_dp14_mst/xdprxss_zcu102_rx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_rxonly.c This file
contains a design example using the XDpRxSs driver in single stream (SST)
transport mode. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 vk 10/04/17 Initial release. 1.01 ku 06/04/19 Minor updates to CRC
reporting to follow VESA recommendation </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/examples/src/zcu_rx_dp14/xdprxss_zcu102_dp14_rxonly.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss.c @addtogroup
dprxss_v5_0 @{ This is the main file for Xilinx DisplayPort Receiver Subsystem
driver. This file contains a minimal set of functions for the XDpRxSs driver
that allow access to all of the DisplayPort Receiver Subsystem core's
functionality. Please see xdprxss.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 05/18/15
Initial release. 2.00 sha 10/05/15 Added HDCP and Timer Counter support.
Protected HDCP under macro number of instances. 2.00 sha 10/15/15 Generate a HPD
interrupt whenever RX cable disconnect/unplug interrupt is detected. 2.00 sha
11/06/15 Modified the order of execution in TP1 callback as DP159 config for TP1
and then link bandwidth callback. 3.0 sha 02/05/16 Added support for multiple
subsystems in a design. 3.0 sha 02/19/16 Added function:
XDpRxSs_DownstreamReady. 3.1 als 08/08/16 Synchronize with new HDCP APIs. 3.1
als 08/08/16 Added HDCP timeout functionality. 3.1 aad 09/06/16 Updates to
support 64-bit base addresses. 3.1 aad 10/17/16 Updated timer initialization 4.0
aad 11/15/16 Modified to use DP159 from dprxss driver 4.0 aad 01/20/17 Added
HDCP FIFO reset for correct initialization of the FIFO 4.0 tu 05/30/17 Moved
timer functions under XPAR_XHDCP_NUM_INSTANCES to solve compiler warnings 4.1 tu
09/08/17 Set Driver side three interrupt handler callback in
XDpRxSs_CfgInitialize function 5.0 yas 01/28/18 Added support for DP 1.4. 5.0 jb
02/19/19 Added support for HDCP22 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss.h @addtogroup
dprxss_v4_2 @{ @details This is the main header file for Xilinx DisplayPort
Receiver Subsystem core. It abstracts Subsystem cores and provides high level
API's to application developer. <b>Core Features</b> For a full description of
DisplayPort Receiver Subsystem core, please see the hardware specification.
<b>Software Initialization & Configuration</b> The application needs to do
following steps in order for preparing the DisplayPort Receiver Subsystem core
to be ready. - Call XDpRxSs_LookupConfig using a device ID to find the core
configuration. - Call XDpRxSs_CfgInitialize to initialize the device and the
driver instance associated with it. <b>Interrupts</b> The DisplayPort RX
Subsystem driver provides the interrupt handlers - XDpRxSs_DpIntrHandler -
XDpRxSs_HdcpIntrHandler - XDpRxSs_TmrCtrIntrHandler, for handling the interrupt
from the DisplayPort, optional HDCP and Timer Counter sub-cores respectively.
The users of this driver have to register this handler with the interrupt system
and provide the callback functions by using XDpRxSs_SetCallBack API. <b>Virtual
Memory</b> This driver supports Virtual Memory. The RTOS is responsible for
calculating the correct device base address in Virtual Memory space.
<b>Threads</b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by defining
at compile time, the NDEBUG identifier. By default, asserts are turned on and it
is recommended that users leave asserts on during development. <b>Building the
driver</b> The DisplayPort Receiver Subsystem driver is composed of several
source files. This allows the user to build and link only those parts of the
driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----
--- -------- 1.00 sha 05/18/15 Initial release. 2.00 sha 10/05/15 Removed HDCP
interrupt handler types. Added HDCP and Timer Counter support. 3.0 sha 02/19/16
Removed indexing from enum XDpRxSs_HandlerType. Added handler type as enum for
HDCP: XDPRXSS_HANDLER_HDCP_RPTR_TDSA_EVENT. Added function:
XDpRxSs_DownstreamReady. 3.1 als 08/08/16 Added HDCP timeout functionality. 3.1
aad 09/07/16 Updates to support 64-bit base addresses. 4.0 aad 12/01/16 Added
interrupt handler for HDCP authentication ms 01/23/17 Modified xil_printf
statement in main function for all examples to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 03/17/17 Modified readme.txt file in examples folder for doxygen generation.
4.1 tu 09/08/17 Added three driver side interrupt handler for Video, NoVideo and
PowerChange events 4.1 jb 02/19/19 Added support for HDCP22. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dbg.c @addtogroup
dprxss_v4_2 @{ This file contains functions to report debug information of
DisplayPort RX Subsystem sub-cores. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 05/18/15 Initial release. 2.00 sha 10/05/15
Added HDCP support. Removed DP159 bit error count code. Used DP159 bit error
count function from Video Common library. 4.00 aad 11/14/16 Modified to use
DP159 from dprxss 4.01 aad 07/06/17 Added MAUD and NAUD to MSA prints. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_dbg.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dp159.c @addtogroup
dprxss_v4_2 @{ This file contains a set of functions to configure the DP159.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha
07/13/15 Initial release. 1.00 sha 08/11/15 Removed extra DP159 register
programming as per new DP159 programming guide. Added bit error count function.
2.2 als 02/01/16 Functions with pointer arguments that don't modify contents now
const. 3.0 aad 05/13/16 Added bus busy check before I2C reads and writes. 3.1
als 08/03/16 Reordered wait for PLL lock. 4.0 aad 11/15/16 Moved to dprxss
driver from video_common 4.0 aad 07/13/17 Updated DP159 read lock status </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_dp159.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_dp159.h @addtogroup
dprxss_v4_2 @{ This is the header file contains macros, enum, structure and
function prototypes for DP159. <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- --- -------- 1.00 sha 07/13/15 Initial release. 1.00 sha 08/11/15 Modified
XDPRXSS_DP159_CT_PWR -> XDPRXSS_DP159_CT_UNPLUG. Added bit error count function.
2.2 als 02/01/16 Functions with pointer arguments that don't modify contents now
const. 3.1 aad 06/16/16 Updated CPI pull down HBR2 value 4.0 aad 11/15/16 Moved
to dprxss form video_common </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_dp159.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

CAUTION: This file is automatically generated by HSI. Version: 2019.1.0 DO NOT
EDIT. All Rights Reserved. Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated documentation files (the
Software), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED AS IS,
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: Driver configuration

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_g.c
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss_g.c
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/src/xhdcp22_cipher_g.c
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/src/xhdcp22_rx_g.c
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/src/xhdcp22_tx_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_hw.h @addtogroup
dprxss_v4_2 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx DisplayPort Receiver
Subsystem. For more information about the operation of this core see the
hardware specification and documentation in the higher level driver xdprxss.h
file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00
sha 05/18/15 Initial release. 2.00 sha 10/05/15 Added Timer Counter reset value
macro. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_intr.c @addtogroup
dprxss_v4_2 @{ This file contains interrupt related functions of Xilinx
DisplayPort RX Subsystem core. Please see xdprxss.h for more details of the
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00
sha 05/18/15 Initial release. 2.00 sha 10/05/15 Removed setting HDCP callbacks.
Added HDCP and Timer Counter interrupt handler. 3.0 sha 02/19/16 Added switch
case for XDPRXSS_HANDLER_HDCP_RPTR_TDSA_EVENT to register callback with HDCP.
4.0 aad 12/01/16 Added HDCP Authentication interrupt handler 4.1 tu 09/06/17
Added three driver side interrupt handler for Video, NoVideo and PowerChange
event 4.1 jb 02/19/19 Added support for HDCP22. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mcdp6000.c @addtogroup
dprxss_v5_0 @{ This file contains a set of functions to configure the MCDP6000.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 Kei
01/23/18 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_mcdp6000.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mcdp6000.c @addtogroup
dprxss_v5_0 @{ This is the header file contains macros, enum, structure and
function prototypes for MCDP6000. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 Kei 01/23/18 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_mcdp6000.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_selftest.c @addtogroup
dprxss_v4_2 @{ This file contains self test function for the DisplayPort
Receiver Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----
--- -------- 1.00 sha 05/18/15 Initial release. 2.00 sha 10/05/15 Added HDCP and
Timer Counter self test. 4.00 tu 25/06/17 Added proper return value </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_sinit.c @addtogroup
dprxss_v4_2 @{ This file contains static initialization method for Xilinx
DisplayPort Receiver Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 05/18/15 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/xdprxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_hdcp22.c This file
contains a minimal set of functions for the High-Bandwidth Content Protection
core to configure. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 jb 02/18/19 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/hdcp22/xdprxss_hdcp22.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdprxss_hdcp22.h This is the
header file for Xilinx DisplayPort Receiver Subsystem sub-core, is High-
Bandwidth Content Protection 2.2 (HDCP2.2). <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- --- -------- 1.00 jb 02/18/19 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14rxss/src/hdcp22/xdprxss_hdcp22.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 2.00 sha 08/07/15 Added HDCP support to work with DP
pass-through. 2.00 sha 09/28/15 Added Timer Counter support to work with DP
pass-through. 3.0 sha 02/05/16 Added support to generate XPAR_ parameters for
multiple subsystems in a design.

FILES:
XilinxProcessorIPLib/drivers/dp14txss/data/dp14txss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_kcu105_dp14.c
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 KI 12/09/17
Initial release.

FILES:
XilinxProcessorIPLib/drivers/dp14txss/examples/src/kcu_dp14/xdptxss_kcu105_dp14.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_vcu118_tx.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 Kei 08/09/17
First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14txss/examples/src/vcu118_dp14_tx/xdptxss_vcu118_tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file dptxss_zcu102_pt_dp14.c This
file contains a design example using the XDpSs driver in single stream (SST)
transport mode to demonstrate Pass-through design. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- --- -------- 1.00 KI 04/01/18 Initial release. 1.01 KU
04/01/19 2019.1 - Updates to RX SetLinkRate, audio enable. - Setting Tx link to
1.62 for improved linkup - Audio starts after infoframe 1.02 KU 06/01/19 2019.2
- Using API to send AudioInfoframe on TX. - CRC is reported on each component
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14/xdptxss_zcu102_dp14_pt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- --- -------- 1.00 KU 02/05/19 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/menus.c
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/xdptxss_zcu102_dp14_mst_pt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_zcu102_tx.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 Kei 08/09/17
First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_pt_dp14_mst/xdptxss_zcu102_mst_pt.h
XilinxProcessorIPLib/drivers/dp14txss/examples/src/zcu_tx_dp14/xdptxss_zcu102_tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss.c @addtogroup
dptxss_v5_1 @{ This is the main file for Xilinx DisplayPort Transmitter
Subsystem driver. This file contains a minimal set of functions for the XDpTxSs
driver that allow access to all of the DisplayPort Transmitter Subsystem core's
functionality. Please see xdptxss.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00 sha 01/29/15
Initial release. 1.00 sha 07/21/15 Renamed sub-cores functions with prefix
XDpTxSs_ 2.00 sha 08/07/15 Added support for customized main stream attributes.
Added HDCP instance into global sub-cores structure. 2.00 sha 09/28/15 Added
HDCP and Timer Counter support. 3.0 sha 02/05/16 Added support for multiple
subsystems in a design. 3.0 sha 02/19/16 Added function: XDpTxSs_ReadDownstream,
XDpTxSs_HandleTimeout. Enabled HDCP in XDpTxSs_Start function. 4.1 aad 07/28/16
Enabled VTC before DPTX core enable for better image stability 4.1 als 08/08/16
Synchronize with new HDCP APIs. aad 09/06/16 Updates to support 64-bit base
address 5.0 tu 07/20/17 Allowing Custom VTM in XDpTxSs_SetVidMode function. 5.0
tu 08/10/17 Adjusted BS symbol for equal timing 5.0 tu 08/11/17 Removing ceil()
to remove dependency on math library. 5.0 tu 09/06/17 Set timer callback after
HDCP initialization 5.0 tu 09/06/17 Added Set UserPixelWidth support on tx side
5.0 tu 09/08/17 Set HPD callbacks for HPD event and HPD pulse 5.0 jb 02/21/19
Added HDCP22 support. Made the Timer counter available for both HDCP1x and 22.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss.h @addtogroup
dptxss_v5_1 @{ @details This is the main header file for Xilinx DisplayPort
Transmitter Subsystem core. It abstracts Subsystem cores and provides high level
API's to application developer. <b>Core Features</b> For a full description of
DisplayPort Transmitter Subsystem core, please see the hardware specification.
<b>Software Initialization & Configuration</b> The application needs to do
following steps in order for preparing the DisplayPort Transmitter Subsystem
core to be ready. - Call XDpTxSs_LookupConfig using a device ID to find the core
configuration. - Call XDpTxSs_CfgInitialize to initialize the device and the
driver instance associated with it. <b>Interrupts</b> The DisplayPort TX
Subsystem driver provides the interrupt handlers - XDpTxSs_DpIntrHandler -
XDpTxSs_HdcpIntrHandler - XDpTxSs_TmrCtrIntrHandler, for handling the interrupt
from the DisplayPort, optional HDCP and Timer Counter sub-cores respectively.
The users of this driver have to register this handler with the interrupt system
and provide the callback functions by using XDpTxSs_SetCallBack API. <b>Virtual
Memory</b> This driver supports Virtual Memory. The RTOS is responsible for
calculating the correct device base address in Virtual Memory space.
<b>Threads</b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by defining
at compile time, the NDEBUG identifier. By default, asserts are turned on and it
is recommended that users leave asserts on during development. <b>Building the
driver</b> The DisplayPort Transmitter Subsystem driver is composed of several
source files. This allows the user to build and link only those parts of the
driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----
--- -------- 1.00 sha 01/29/15 Initial release. 1.00 sha 07/21/15 Included
renamed sub-cores header files. 2.00 sha 08/07/15 Added new handler types: lane
count, link rate, pre-emphasis voltage swing adjust and set MSA. Added support
for customized main stream attributes. Added function:
XDpTxSs_SetHasRedriverInPath. Added HDCP support data structure. 2.00 sha
09/28/15 Added HDCP and Timer Counter functions. 3.0 sha 02/19/16 Added handler
type as enums for HDCP: XDPTXSS_HANDLER_HDCP_RPTR_DWN_STRM_RDY,
XDPTXSS_HANDLER_HDCP_RPTR_EXCHG. Added function: XDpTxSs_ReadDownstream,
XDpTxSs_HandleTimeout. 4.0 aad 05/13/16 Expose API to set (a)synchronous clock
mode from DP driver. 4.1 als 08/08/16 Synchronize with new HDCP APIs. aad
09/06/16 Updates to support 64-bit base addresses. ms 01/23/17 Modified
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Modified readme.txt file in examples folder for
doxygen generation. 5.0 tu 08/10/17 Adjusted BS symbol for equal timing 5.0 tu
09/08/17 Added two interrupt handler that addresses driver's internal callback
function of application DrvHpdEventHandler and DrvHpdPulseHandler Added HPD user
data stucture XDpTxSs_UsrHpdPulseData and XDpTxSs_UsrHpdEventData 5.0 jb
02/21/19 Added HDCP22 support. Made the Timer counter available for both HDCP1x
and 22. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_dbg.c @addtogroup
dptxss_v5_1 @{ This file contains functions to report debug information of
DisplayPort TX Subsystem sub-cores. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 01/29/15 Initial release. 2.00 sha 08/07/15
Updated register offsets in debug MSA info. 2.00 sha 09/28/15 Added HDCP debug
function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss_dbg.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_hw.h @addtogroup
dptxss_v5_1 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx DisplayPort
Transmitter Subsystem core. For more information about the operation of this
core see the hardware specification and documentation in the higher level driver
xdptxss.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 sha 01/29/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_intr.c @addtogroup
dptxss_v5_1 @{ This file contains interrupt related functions of Xilinx
DisplayPort TX Subsystem core. Please see xdptxss.h for more details of the
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00
sha 01/29/15 Initial release. 2.00 sha 08/07/15 Added new handler types: lane
count, link rate, Pre-emphasis voltage swing adjust and Set MSA. 2.00 sha
09/28/15 Added HDCP and Timer Counter interrupt handlers. 3.0 sha 02/19/16 Added
switch cases for XDPTXSS_HANDLER_HDCP_RPTR_DWN_STRM_RDY and
XDPTXSS_HANDLER_HDCP_RPTR_EXCHG to register callback with HDCP. 4.1 als 08/08/16
Synchronize with new HDCP APIs. 5.0 tu 09/08/17 Added two interrupt handler that
addresses driver's internal callback function of application DrvHpdEventHandler
and DrvHpdPulseHandler 5.0 jb 02/21/19 Added HDCP22 callback handles. Made the
Timer counter interrupt handler available for both HDCP1x and 22. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_selftest.c @addtogroup
dptxss_v5_1 @{ This file contains self test function for the DisplayPort
Transmitter Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- --- -------- 1.00 sha 01/29/15 Initial release. 2.00 sha 09/28/15 Added
HDCP and Timer Counter self test. 4.1 tu 25/06/17 Added return values </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_sinit.c @addtogroup
dptxss_v5_1 @{ This file contains static initialization method for Xilinx
DisplayPort Transmitter Subsystem core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 01/29/15 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/xdptxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_hdcp22.c This file
contains a minimal set of functions for the High-Bandwidth Content Protection
core to configure. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.00 jb 02/21/19 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/hdcp22/xdptxss_hdcp22.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdptxss_hdcp22.h This is the
header file for Xilinx DisplayPort Transmitter Subsystem sub-core, is High-
Bandwidth Content Protection (HDCP22). <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 jb 02/21/19 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dp14txss/src/hdcp22/xdptxss_hdcp22.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 aad 01/27/17 Created uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/dpdma/data/dpdma.tcl
XilinxProcessorIPLib/drivers/dppsu/data/dppsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdpdma_video_example.c This
file contains a design example using the DPDMA driver (XDpDma) This example
demonstrates the use of DPDMA for displaying a Graphics Overlay @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.0 aad
10/19/17 Initial Release 1.1 aad 02/22/18 Fixed the header </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/dpdma/examples/xdpdma_video_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdpdma_video_example.h This
file contains a design example using the DPDMA driver (XDpDma) This example
demonstrates the use of DPDMA for displaying a Graphics Overlay @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.0 aad
10/19/17 Initial Release </pre>

FILES:
XilinxProcessorIPLib/drivers/dpdma/examples/xdpdma_video_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_interrupt.c This file
XDpPsu interrupt handlers. Upon Hot Plug-Detect (HPD - DisplayPort cable is
plugged/unplugged or the monitor is turned on/off), the main link will be
trained. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.0 aad 10/19/17 Initial Release 1.1 aad 02/22/18 Fixed the header
</pre>

FILES:
XilinxProcessorIPLib/drivers/dpdma/examples/xdppsu_interrupt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdpdma.c This file contains the
implementation of the interface functions of the XDpDma driver. Refer to
xdpdma.h for detailed information. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ---- ----- -------- 1.0 aad 04/12/16 Initial release. 1.1 aad
04/26/18 Fixed Warnings </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/dpdma/src/xdpdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xdpdma.h This file defines
the functions implemented by the DPDMA driver present in the Zynq Ultrascale MP.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----- --------
1.0 aad 04/12/16 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/dpdma/src/xdpdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xdpdma_hw.h This header file
contains identifiers and low-level driver functions (or macros) that can be used
to access the device. High-level driver functions are defined in xdpdma.h @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----- -------- 1.0
aad 04/12/16 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/dpdma/src/xdpdma_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdpdma_intr.c This file
contains functions related to XDpPsu interrupt handling. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 01/17/17
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dpdma/src/xdpdma_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdpdma_sinit.c @addtogroup
dpdma_v1_0 @{ This file contains static initialization methods for the XDpDma
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 aad 01/20/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dpdma/src/xdpdma_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- -------- 1.0 vsa 07/03/15 Initial version 1.1 vsa 03/02/17 Add
support for HS_SETTLE register

FILES:
XilinxProcessorIPLib/drivers/dphy/data/dphy.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdphy_example_selftest.c <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.1 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation of examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dphy/examples/xdphy_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdphy.c @addtogroup dphy_v1_0
@{ This file implements the functions to control and get info from the DPHY.
<pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa
07/08/15 Initial release 1.1 sss 08/17/16 Added 64 bit support 1.2 vsa 03/02/17
Add support for HS_SETTLE register </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dphy/src/xdphy.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdphy.h @addtogroup dphy_v1_0
@{ @details This file contains the implementation of the MIPI DPHY Controller
driver. User documentation for the driver functions is contained in this file in
the form of comment blocks at the front of each function. <b>MIPI DPHY
Overview</b> The DPHY currently supports the MIPI?Alliance Specification for
DPHY Version 1.1. It is capable of synchronous transfer at high speed mode at
80-1500 Mbps It has one clock lane and up to 4 data lanes. These lanes are
unidirectional. It can do asynchronous transfer at upto 10 Mbps in low power
mode. The clock lane can be in low power mode or high speed mode whereas the
data lanes can be in Low power, High power or Escape mode. The programmable
parameters like IDelay, Wakeup, HS Timeout, Esc Timeout are present and various
status like Stop state, Error detected, ULPS state,etc are available through the
status register <b>Core Features</b> The GUI in IPI allows for the following
configurations - Lanes ( 1 to 4 ) - Line Rate (80 - 1500 Mbps) - Data Flow
direction (Tx or Rx) - Escape Clock (10 - 20 Mhz) - LPX period (50 - 100 ns) -
Enable register interface - HS Timeout in Bytes (1000 - 65541) - Escape Timeout
in ns (800 - 25600) <b>Software Initialization & Configuration</b> By default,
the DPHY core is initialized and ready. The application needs to do following
steps in order for preparing the MIPI DPHY core to be ready. - Call
XDphy_LookupConfig using a device ID to find the core configuration. - Call
XDphy_CfgInitialize to initialize the device and the driver instance associated
with it. - Individual parameters can be configured by sending values with
appropriate handles. <b>Interrupts</b> There are no interrupts from the DPHY.
<b> Virtual Memory </b> This driver supports Virtual Memory. The RTOS is
responsible for calculating the correct device base address in Virtual Memory
space. <b> Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by
defining, at compile time, the NDEBUG identifier. By default, asserts are turned
on and it is recommended that application developers leave asserts on during
development. <b>Building the driver</b> The DPHY driver is composed of source
files and doesn't depend on any other drivers. <pre> MODIFICATION HISTORY: Ver
Who Date Changes --- --- -------- 1.0 vsa 07/08/15 Initial release 1.1 sss
08/17/16 Added 64 bit support ms 01/23/17 Modified xil_printf statement in main
function for all examples to ensure that "Successfully ran" and "Failed" strings
are available in all examples. This is a fix for CR-965028. 1.2 vsa 03/02/17 Add
support for HS_SETTLE register ms 03/17/17 Added readme.txt file in examples
folder for doxygen generation. ms 04/05/17 Modified Comment lines in functions
of dphy examples to recognize it as documentation block for doxygen generation
of examples. </pre>

FILES:
XilinxProcessorIPLib/drivers/dphy/src/xdphy.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdphy_hw.h @addtogroup
xdphy_v1_0 @{ Hardware definition file. It defines the register interface. <pre>
MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa 07/07/15
Initial release 1.1 sss 08/17/16 Added 64 bit support 1.2 vsa 03/02/17 Add
support for HS_SETTLE register </pre>

FILES:
XilinxProcessorIPLib/drivers/dphy/src/xdphy_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdphy_selftest.c @addtogroup
dphy_v1_0 @{ Contains diagnostic/self-test functions for the XDphy component.
<pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa
07/09/15 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dphy/src/xdphy_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdphy_sinit.c @addtogroup
dphy_v1_0 @{ Look up the hardware settings using device ID. The hardware setting
is inside the configuration table in xdphy_g.c, generated automatically by XPS
or manually by the user. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---
--- -------- 1.0 vsa 07/09/15 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dphy/src/xdphy_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_example_common.c
Contains a design example using the XDpPsu driver. It performs a self test on
the DisplayPort TX core by training the main link at the maximum common
capabilities between the TX and RX and checking the lane status. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 09/17/17
Initial creation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/examples/xdppsu_common_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_example_common.h
Contains a design example using the XDpPsu driver. It performs a self test on
the DisplayPort TX core by training the main link at the maximum common
capabilities between the TX and RX and checking the lane status. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 09/17/17
Initial creation. </pre>

FILES:
XilinxProcessorIPLib/drivers/dppsu/examples/xdppsu_common_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_intr_example.c Contains
a design example using the XDpPsu driver with interrupts. Upon Hot Plug-Detect
(HPD - DisplayPort cable is plugged/unplugged or the monitor is turned on/off),
the main link will be trained. @note This example requires an interrupt
controller connected to the processor and the DisplayPort TX core in the system.
@note For this example to display output, the user will need to select the Test
Pattern Generator or initialize and select an appropriate source. @note The
functions DpPsu_PlatformInit and DpPsu_StreamSrc are declared extern in
xdppsu_common_example.h and are left up to the user to implement. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 09/04/17
Initial creation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/examples/xdppsu_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_poll_example.c Contains
a design example using the XDpPsu driver with polling. Once the polling detects
a Hot-Plug-Detect event (HPD - DisplayPort cable is plugged/ unplugged or the
monitor is turned on/off), the main link will be trained. @note For this example
to display output, the user will need to implement initialization of the system
(DpPsu_PlatformInit) and, after training is complete, implement configuration of
the video stream source in order to provide the DisplayPort core with input
(DpPsu_StreamSrc - called in xdppsu_common_example.c). @note The functions
DpPsu_PlatformInit and DpPsu_StreamSrc are declared extern in
xdppsu_common_example.h and are left up to the user to implement. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 14/10/17
Initial creation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/examples/xdppsu_poll_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_selftest_example.c
Contains a design example using the XDpPsu driver. It performs a self test on
the DisplayPort TX core that will compare many of the DisplayPort TX core's
registers against their default reset values. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 10/17/17 Initial
creation. </pre> Function Prototypes /

FILES:
XilinxProcessorIPLib/drivers/dppsu/examples/xdppsu_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu.c Contains a minimal set
of functions for the XDpPsu driver that allow access to all of the DisplayPort
TX core's functionality. See xdppsu.h for a detailed description of the driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 aad 01/27/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu.h The Xilinx DisplayPort
transmitter (DPTX_PS) driver. This driver supports the Xilinx DisplayPort PS
core in TX mode. This driver follows the DisplayPort 1.2a specification. The
Xilinx DisplayPort soft IP supports the following features: - 1, 2 lanes. - A
link rate of 1.62, 2.70, or 5.40Gbps per lane. - 1, 2, or 4 pixel-wide video
interfaces. - RGB and YCbCr color space. - Up to 12 bits per component. - Up to
4Kx2K monitor resolution. - Auto lane rate and width negotiation. - I2C over a
1Mb/s AUX channel. - Secondary channel audio support (2 channels). <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 05/17/14
Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_edid.c This file
contains functions related to accessing the Extended Display Identification Data
(EDID) of a specified sink using the XDpPsu driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 27/01/17
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_hw.h This header file
contains the identifiers and low-level driver functions (or macros) that can be
used to access the device. High-level driver functions are defined in xdppsu.h.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 aad 23/01/17 Initial release. 1.1 aad 10/04/17 Removed un-applicable
registers </pre>

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_intr.c This file
contains functions related to XDpPsu interrupt handling. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 01/17/17
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_selftest.c This file
contains a diagnostic self-test function for the XDpPsu driver. It will check
many of the DisplayPort TX's register values against the default reset values as
a sanity-check that the core is ready to be used. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 01/17/17 Initial
release. 1.1 aad 10/04/17 Removed not applicable registers </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_serdes.c Contains the
set of functions used by the XDpPsu driver to configure SERDES. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad
01/27/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_serdes.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_serdes.h This file
contains all the functions used by DisplayPort to configure SERDES for link
training <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 aad 05/17/14 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_serdes.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_sinit.c This file
contains static initialization methods for the XDpPsu driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 aad 05/17/17
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdppsu_spm.c This file contains
the stream policy maker functions for the XDpPsu driver. These functions set up
the DisplayPort TX core's main stream attributes that determine how a video
stream will be displayed. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 aad 01/17/17 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dppsu/src/xdppsu_spm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- ------- 1.0 ram 11/2/16 Initial Release for MIPI DSI TX
subsystem uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/dsi/data/dsi.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- ------- 1.0 ram 11/2/16 Initial Release for MIPI DSI TX
subsystem Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types
(swproj): 0 : MemoryTest - Calls basic memorytest routines from common driver
dir 1 : PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/dsi/data/dsi_tapp.tcl
XilinxProcessorIPLib/drivers/dsitxss/data/dsitxss_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsi_example_selftest.c @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.1 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 04/05/17 Modified Comment lines in functions to recognize
it as documentation block for doxygen generation of examples. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/dsi/examples/xdsi_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsi.c @addtogroup dsi_v1_1 @{
This file implements the functions to control and get info from the DSI TX
Controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- ------- 1.0
ram 11/02/16 Initial Release DSI driver 1.1 sss 08/17/16 Added 64 bit support
sss 08/26/16 Add "Command Queue Vacancy" API </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsi/src/xdsi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsi.h @addtogroup dsi_v1_1 @{
@details This file contains the implementation of the MIPI DSI TX Controller
driver. User documentation for the driver functions is contained in this file in
the form of comment blocks at the front of each function. <pre> MODIFICATION
HISTORY: Ver Who Date Changes --- --- ------- 1.0 ram 11/02/16 Initial Release
for DSI driver 1.1 sss 08/17/16 Added 64 bit support sss 08/26/16
XDSI_VM_NON_BURST_SYNC_PULSES enum changed Add "Command Queue Vacancy" API API
for getting pixel format ms 01/23/17 Modified xil_printf statement in main
function for all examples to ensure that "Successfully ran" and "Failed" strings
are available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. ms 04/05/17 Modified
Comment lines in functions of dsi examples to recognize it as documentation
block for doxygen generation of examples. </pre>

FILES:
XilinxProcessorIPLib/drivers/dsi/src/xdsi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsi_hw.h @addtogroup dsi_v1_1
@{ Hardware definition file. It defines the register interface. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 ram 02/11/16
First release 1.1 sss 08/17/16 Added 64 bit support sss 08/26/16 Add "Command
queue Vacancy" api support Add "Command queue FIFO Full" interrupt support
</pre> /

FILES:
XilinxProcessorIPLib/drivers/dsi/src/xdsi_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsi_intr.c @addtogroup
dsi_v1_1 @{ This file implements the functions which handle the interrupts in
the DSI TX Controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 ram 02/11/16 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsi/src/xdsi_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsi_selftest.c @addtogroup
dsi_v1_1 @{ Contains diagnostic/self-test functions for the XDsi Controller
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 ram 02/11/16 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsi/src/xdsi_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsi_sinit.c @addtogroup
dsi_v1_1 @{ Look up the hardware settings using device ID. The hardware setting
is inside the configuration table in xdsi_g.c, generated automatically by XPS or
manually by the user. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 ram 02/11/16 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsi/src/xdsi_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- ------- 1.0 ram 11/02/16 Initial Release for MIPI DSI TX
subsystem 1.1 sss 08/17/16 Added 64 bit support

FILES:
XilinxProcessorIPLib/drivers/dsitxss/data/dsitxss.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 ram 02/15/16 Initial version for MIPI DSI
TX subsystem 1.1 vsa 08/31/17 Fix for IP with different name

FILES:
XilinxProcessorIPLib/drivers/dsitxss/data/dsitxss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss_intr_example.c This
file contains a design example using the XDsiTxSs driver with interrupts. This
will provide interrupts for pixel under run and undefined data type <pre>
MODIFICATION HISTORY: Ver Who Date Changes --- --- ------- 1.0 ram 11/2/16
Initial Release for MIPI DSI TX subsystem 1.1 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Added tabspace for return statements in functions for proper documentation while
generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsitxss/examples/xdsitxss_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss_selftest_example.c
This file contains a design example using the XDsiTxSs driver. It performs a
self test on the MIPI DSI Tx Subsystem that will test its sub-cores self test
functions. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
------- 1.0 ram 11/2/16 Initial Release for MIPI DSI TX subsystem 1.1 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsitxss/examples/xdsitxss_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss_video_test_example.c
This file contains a design example using the XDsiTxSs driver. It performs a
video test on the MIPI DSI Tx Subsystem. It tests DSI TX functionality with
following sequence. Presently the application is supporting only RGB888 format.
3 bytes per pixel BRAM -- (MM2S)--VDMA (MM2S)--DSI TX-- CSI RX --
(S2MM)VDMA(S2MM)--BRAM This function will read input from BRAM0, provide BRAM
input to VDMA MM2S, VDMA feeds MM2S input to DSI TX controller, the output of
DSI will be connected to CSI RX controller. The output of CSI given to S2MM of
VDMA. VDMA writes S2MM data on BRAM1. Finally compare BRAM0 and BRAM1 data User
has to provide all necessary inputs as per desired resolution @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes --- --- ------- 1.0 ram 11/2/16
Initial Release for MIPI DSI TX subsystem 1.1 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsitxss/examples/xdsitxss_video_test_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss.c @addtogroup
dsitxss_v1_1 @{ This is main code of Xilinx MIPI DSI Tx Subsystem device driver.
Please see xdsitxss.h for more details of the driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes --- --- ------- 1.0 ram 11/02/16 Initial Release
for MIPI DSI TX subsystem 1.1 sss 08/17/16 Added 64 bit support sss 08/26/16 Add
"Command Queue Vacancy" API API for getting pixel format </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsitxss/src/xdsitxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss.h @addtogroup
dsitxss_v1_1 @{ @details This is main header file of the Xilinx MIPI DSI Tx
Subsystem driver <b>MIPI DSI Tx Subsystem Overview</b> MIPI DSI Subsystem is
collection of IP cores defines high speed serial interface between display
peripheral and host processor. DSI Subsystem translate data received from a MIPI
DSI Transmitter. The MIPI DSI Tx Subsystem is a plug-in solution for interfacing
with MIPI DSI core. It hides all the complexities of programming the underlying
cores from the end user. <b>Subsystem Features</b> MIPI DSI Tx Subsystem
supports following features - Support for 1 to 4 Data Lanes. - Line rates
ranging from 80 to 1500 Mbps. - Different data type
support(RGB888,RGB566,RGB666L,RGB666P). - Filtering of packets based on Virtual
channel ID. - Single,Dual,Quad input pixel per beat <b>Subsystem
Configurations</b> The GUI in IPI allows for the following configurations -
Lanes ( 1 to 4 ) - Pixel Format ( (RGB888,RGB566,RGB666L,RGB666P). - Number of
Input Pixels per beat(1, 2, 4) - DPHY with/without Register interface - Line
Rate - CRC Generation Enable In order to reduce resource usage, the DPHY can be
configured to be without register interface with fixed functions. Static
configuration parameters are stored in xdsitxss_g.c file, that gets generated
when compiling the board support package (BSP). A table is defined where each
entry contains configuration information for the instances of the subsystem in
the design. This information includes the elected configuration, sub-cores used
and their device ID, base addresses of memory mapped devices and address range
available for subsystem frame/field buffers. The subsystem driver itself always
includes the full software stack irrespective of the configuration selected.
Generic API's are provided to interact with the subsystem and/or with the
included sub -cores. At run-time the subsystem will query the static
configuration and configures itself for supported use cases <b>Subsystem Driver
Description</b> The subsystem driver provides an abstraction on top of the DSI
and DPHY drivers. <b>Interrupt Service</b> The DSI TX subsytem supports 2
interrupts 1. Unsupported Data Type 2. Pixel Under flow error For Handling these
interrupts, The users of this driver have to register this handler with the
interrupt system and provide the callback functions by using XDSiTxSsSetCallback
API <b>Virtual Memory </b> This driver supports Virtual Memory. The RTOS is
responsible for calculating the correct device base address in Virtual Memory
space. <b>Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by
defining, at compile time, the NDEBUG identifier. By default, asserts are turned
on and it is recommended that application developers leave asserts on during
development. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------
1.0 ram 11/02/16 Initial Release for MIPI DSI TX subsystem 1.1 sss 08/17/16
Added 64 bit support sss 08/26/16 Add "Command Queue Vacancy" API API for
getting pixel format ms 01/23/17 Modified xil_printf statement in main function
for all examples to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. ms 04/05/17 Added
tabspace for return statements in functions of xdsitxss_intr_example.c for
proper documentation while generating doxygen. </pre>

FILES:
XilinxProcessorIPLib/drivers/dsitxss/src/xdsitxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss_hw.h @addtogroup
dsitxss_v1_1 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx MIPI DSI Tx
Subsystem core. For more information about the operation of this core see the
hardware specification and documentation in the higher level driver xdsitxss.h
file. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- ------- 1.0 ram
11/02/16 Initial Release for MIPI DSI TX subsystem 1.1 sss 08/17/16 Added 64 bit
support sss 08/26/16 Added "Command Queue Vacancy FIFO Full" interrupt support
</pre>

FILES:
XilinxProcessorIPLib/drivers/dsitxss/src/xdsitxss_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss_intr.c @addtogroup
dsitxss_v1_1 @{ This is the interrupt handling part of the Xilinx MIPI DSI Tx
Subsystem device driver. The interrupt registration and handler are defined
here. The callbacks are registered for events which are interrupts clubbed
together on the basis of the DSI specification. Refer to DSI driver for the
event groups. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------
1.0 ram 11/02/16 Initial Release for MIPI DSI TX subsystem 1.1 sss 08/26/16
Added "Command Queue Vacancy FIFO Full" interrupt support </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsitxss/src/xdsitxss_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss_selftest.c @addtogroup
dsitxss_v1_1 @{ This file contains self test function for the MIPI DSI Tx
Subsystem <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- ------- 1.0
ram 11/2/16 Initial Release for MIPI DSI TX subsystem </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsitxss/src/xdsitxss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdsitxss_sinit.c @addtogroup
dsitxss_v1_1 @{ This file contains the implementation of the MIPI DSI Tx
Subsystem driver's static initialization functionality. <pre> MODIFICATION
HISTORY: Ver Who Date Changes --- --- ------- 1.0 ram 11/2/16 Initial Release
for MIPI DSI TX subsystem </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dsitxss/src/xdsitxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdualsplitter_example.c This
file contains an example of how to use the Dual Splitter driver. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00 sha
08/05/14 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dual_splitter/examples/xdualsplitter_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdualsplitter.c @addtogroup
dual_splitter_v1_1 @{ This file contains the implementation of the interface
functions for Dual Splitter core. Please refer to the header file
xdualsplitter.h for more detailed information. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.00 sha 07/21/14 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/dual_splitter/src/xdualsplitter.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdualsplitter.h @addtogroup
dual_splitter_v1_1 @{ @details This header file contains identifiers and
register-level core functions (or macros), range macros, structure typedefs that
can be used to access the Xilinx Dual Splitter core. <b>Core Features </b> For
full description of Dual Splitter features, please see the hardware
specification. <b>Initialization & Configuration</b> The application needs to do
the following steps in order to use Dual Splitter core. - Call
XDualSplitter_LookupConfig using a device ID to find the core configuration. -
Call XDualSplitter_CfgInitialize to initialize the device and the driver
instance associated with it. <b> Interrupts </b> The driver provides an
interrupt handler XDualSplitter_IntrHandler for handling the interrupt from the
Dual Splitter core. The users of this driver have to register this handler with
the interrupt system and provide the callback functions by using
XDualSplitter_SetCallBack API. <b> Virtual Memory </b> This driver supports
Virtual Memory. The RTOS is responsible for calculating the correct device base
address in Virtual Memory space. <b> Threads </b> This driver is not thread
safe. Any needs for threads or thread mutual exclusion must be satisfied by the
layer above this driver. <b> Asserts </b> Asserts are used within all Xilinx
drivers to enforce constraints on argument values. Asserts can be turned off on
a system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The Dual Splitter driver is
composed of several source files. This allows the user to build and link only
those parts of the driver that are necessary. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.00 sha 07/21/14 Initial release. ms
03/17/17 Added readme.txt file in examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/dual_splitter/src/xdualsplitter.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdualsplitter_hw.h @addtogroup
dual_splitter_v1_1 @{ This header file contains identifiers and register-level
driver functions (or macros) that can be used to access the Xilinx Dual Splitter
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00
sha 07/21/14 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/dual_splitter/src/xdualsplitter_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdualsplitter_intr.c
@addtogroup dual_splitter_v1_1 @{ This file contains interrupt related functions
for Xilinx Dual Splitter core. Please see xdualsplitter.h for more details of
the core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.00 sha 07/21/14 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dual_splitter/src/xdualsplitter_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdualsplitter_selftest.c
@addtogroup dual_splitter_v1_1 @{ This file contains self test function for the
Dual Splitter core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00 sha 07/21/14 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dual_splitter/src/xdualsplitter_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdualsplitter_sinit.c
@addtogroup dual_splitter_v1_1 @{ This file contains static initialization
function for Xilinx Dual Splitter core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00 sha 07/21/14 Initial release. 1.00 sha 07/08/15
Defined macro XPAR_XDUALSPLITTER_NUM_INSTANCES if not defined in xparameters.h.
1.1 tu 09/18/17 Removed compilation warning in function
XDualSplitter_LookupConfig() </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/dual_splitter/src/xdualsplitter_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 10/12/13 Removed support for xps
emaclite

FILES:
XilinxProcessorIPLib/drivers/emaclite/data/emaclite.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 4.0 adk 10/12/13 Updated as per the New Tcl API's
@BEGIN_CHANGELOG EDK_M Removed the local ::hsi::utils::define_canonical_xpars
API as there is a common API in the tcl of the tools @END_CHANGELOG
@BEGIN_CHANGELOG EDK_LS3 Updated to handle the corner cases described in CR
518193 while generating canonical definitions @END_CHANGELOG uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/emaclite/data/emaclite.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Ver Who Date Changes ----- ----
-------- 4.0 adk 10/12/13 Updated as per the New Tcl API's @BEGIN_CHANGELOG
EDK_I - include header files @END_CHANGELOG @BEGIN_CHANGELOG EDK_H - Initial
Revision @END_CHANGELOG @BEGIN_CHANGELOG EDK_LS2 - Updated the tcl to use
additional files provided with the examples @END_CHANGELOG Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/emaclite/data/emaclite_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_example.h Defines
common data types, prototypes, and includes the proper headers for use with the
EmacLite example code residing in this directory. This file along with
xemaclite_example_util.c are utilized with the specific example code in the
other source code files provided. These examples are designed to be compiled and
utilized within the EDK standalone BSP development environment. The readme file
contains more information on build requirements needed by these examples. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 2.00a ktn
04/13/09 First release 3.03a bss 09/01/12 Moved the declarations of
RecvFrameLength TransmitComplete, EmacLiteInstance, TxFrame[XEL_MAX_FRAME_SIZE],
RxFrame[XEL_MAX_FRAME_SIZE]; to xemaclite_example_util.c for fixing C++
compilation errors </pre>

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_example_util.c This
file implements the utility functions for the EmacLite example code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 2.00a ktn
04/13/09 First release 2.00a ktn 06/13/09 Changed the EmacLitePhyDetect function
so that the function is not in an infinite loop in case of a faulty Phy device.
3.03a bss 09/01/12 Moved the declarations of RecvFrameLength, TransmitComplete,
EmacLiteInstance TxFrame[XEL_MAX_FRAME_SIZE], RxFrame[XEL_MAX_FRAME_SIZE] from
the xemaclite_example.h to this file for fixing C++ compilation errors </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_example_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xemaclite_internal_loopback_example.c This file contains a example for using
EmacLite hardware and driver. This file contains an interrupt example outlining
the use of interrupts and callbacks in the transmission/reception of Ethernet
frames using internal loop back with an incrementing payload from 1 byte to 1500
bytes (excluding Ethernet Header and FCS). This example assumes that there is an
interrupt controller in the hardware system and the EmacLite device is connected
to the interrupt controller. @note None <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.01a ecm 05/21/04 First release 1.01a sv 06/06/05
Minor changes to comply to Doxygen and coding guidelines 2.00a ktn 02/25/09
Updated to use internal loop back feature 2.01a ktn 07/20/09 Updated the example
to wait for either Transmit complete or Rx packet reception. 3.00a ktn 10/22/09
Updated the example to use the HAL APIs/macros. Updated example to use the
macros that have been changed in the driver to remove _m from the name of the
macro. 3.01a ktn 07/08/10 Updated example to support Little Endian MicroBlaze.
4.3 ms 01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_internal_loopback_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_intr_example.c This
file contains an example for using the EmacLite hardware and driver. This file
contains an interrupt example outlining the use of interrupts and callbacks in
the transmission/reception of an Ethernet frame of 1000 bytes of payload. If the
MDIO interface is NOT configured in the EmacLite core then this example will
transmit a frame. If the MDIO interface is configured in the EmacLite core then
this example will enable the MAC loopback in the PHY device, then transmit the
frame and compare the received frame. @note None <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.01a ecm 05/21/04 First release 1.01a sv
06/06/05 Minor changes to comply to Doxygen and coding guidelines 1.01a sv
06/06/06 Minor changes for supporting Test App Interrupt examples 2.00a ktn
02/25/09 Updated to use PHY loop back if MDIO is configured in core 3.00a ktn
10/22/09 Updated the example to use the HAL APIs/macros. Updated example to use
the macros that have been changed in the driver to remove _m from the name of
the macro. 3.01a ktn 07/08/10 Updated example to support Little Endian
MicroBlaze. 4.2 adk 29/02/16 Updated example to support Zynq and ZynqMP. 4.3 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xemaclite_phy_loopback_example.c This file contains a example for using EmacLite
hardware and driver. This file contains an interrupt example outlining the use
of interrupts and callbacks in the transmission/reception of Ethernet frames
using MAC loop back in the PHY device with an incrementing payload from 1 byte
to 1500 bytes (excluding Ethernet Header and FCS). This example assumes that
there is an interrupt controller in the hardware system and the EmacLite device
is connected to the interrupt controller. @note None <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 2.00a ktn 02/25/09 First release 2.01a
ktn 07/20/09 Updated the example to wait for either Transmit complete or Rx
packet reception. 3.00a ktn 10/22/09 Updated the example to use the HAL
APIs/macros. Updated example to use the macros that have been changed in the
driver to remove _m from the name of the macro. 3.01a ktn 07/08/10 Updated
example to support Little Endian MicroBlaze. 4.3 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_phy_loopback_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_ping_reply_example.c
This file contains an EmacLite ping reply example in polled mode. This example
will generate a ping reply when it receives a ping request packet from the
external world. @note The local IP address is set to 172.16.63.121. User needs
to update LocalIpAddr variable with a free IP address based on the network on
which this example is to be run. The local MAC address is set to 0x000A35030201.
User can update LocalMacAddr variable with a valid MAC address. The first three
bytes contains the manufacture ID. 0x000A35 is XILINX manufacture ID. This
program will respond continuously to a number of ping requests as defined by
MAX_PING_REPLIES in this file. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a ktn 20/08/08 First release 3.00a ktn 10/22/09 Updated
example to use the macros that have been changed in the driver to remove _m from
the name of the macro. 3.01a ktn 08/06/10 Updated the example to support little
endian MicroBlaze. 4.3 ms 01/23/17 Added xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_ping_reply_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_ping_req_example.c
This file contains a EmacLite Ping request example in polled mode. This example
will generate a ping request for the specified IP address. @note The local IP
address is set to 172.16.63.121. User needs to update LocalIpAddr variable with
a free IP address based on the network on which this example is to be run. The
Destination IP address is set to 172.16.63.61. User needs to update
DestIpAddress variable with any valid IP address based on the network on which
this example is to be run. The local MAC address is set to 0x000A35030201. User
can update LocalMacAddr variable with a valid MAC address. The first three bytes
contains the manufacture ID. 0x000A35 is XILINX manufacture ID. This program
will generate the specified number of ping request packets as defined in
"NUM_OF_PING_REQ_PKTS". <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a ktn 27/08/08 First release 3.00a ktn 10/22/09 Updated
example to use the macros that have been changed in the driver to remove _m from
the name of the macro. 3.01a ktn 08/06/10 Updated the example to support little
endian MicroBlaze. 4.3 ms 01/23/17 Added xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_ping_req_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_polled_example.c This
file contains an example for using the EmacLite hardware and driver. This file
contains an polled mode example outlining the transmission/reception of an
Ethernet frame of 1000 bytes of payload. If the MDIO interface is NOT configured
in the EmacLite core then this example will only transmit a frame. If the MDIO
interface is configured in the EmacLite core then this example will enable the
MAC loopback in the PHY device, then transmit the frame and compare the received
frame. @note <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.01a ecm 21/05/04 First release 1.01a sv 06/06/05 Minor changes to
comply to Doxygen and coding guidelines 2.00a ktn 02/25/09 Updated to use PHY
loop back if MDIO is configured in core and updated to be used in Test App 3.00a
ktn 10/22/09 Updated example to use the macros that have been changed in the
driver to remove _m from the name of the macro. 3.01a ktn 07/08/10 Updated
example to support Little Endian MicroBlaze. 4.3 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. 4.4 rsp
11/04/18 Fix poll example failure when I/D cache is disabled. It's a corner case
when on network there is a packet reception before send i.e during phy loopback
setup. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_selftest_example.c
This file contains a design example using the EmacLite driver. @note None.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm
01/25/05 Initial release for TestApp integration. 1.00a sv 06/06/05 Minor
changes to comply to Doxygen and coding guidelines 2.00a ktn 04/14/09 Removed
support for TestApp 4.3 ms 01/23/17 Added xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/examples/xemaclite_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite.c @addtogroup
emaclite_v4_4 @{ Functions in this file are the minimum required functions for
the EmacLite driver. See xemaclite.h for a detailed description of the driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a ecm
01/31/04 First release 1.11a mta 03/21/07 Updated to new coding style 1.11a ecm
05/18/07 Updated the TxBufferAvailable routine to look at both the active and
busy bits 1.13a sv 02/1/08 Updated the TxBufferAvailable routine to return busy
status properly 2.00a ktn 02/16/09 Added support for MDIO 2.01a ktn 07/20/09
Modified XEmacLite_Send function to use Ping buffers Interrupt enable bit since
this alone is used to enable the interrupts for both Ping and Pong Buffers.
3.00a ktn 10/22/09 Updated driver to use the HAL APIs/macros. The macros have
been renamed to remove _m from the name. 3.01a ktn 07/08/10 The macro
XEmacLite_GetReceiveDataLength is changed to a static function. Updated the
XEmacLite_GetReceiveDataLength and XEmacLite_Recv functions to support little
endian MicroBlaze. 3.02a sdm 07/22/11 Removed redundant code in XEmacLite_Recv
functions for CR617290 3.04a srt 04/13/13 Removed warnings (CR 705000). 4.2 sk
11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototypes of XEmacLite_GetReceiveDataLength, XEmacLite_CfgInitialize API's.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite.h @addtogroup
emaclite_v4_4 @{ @details The Xilinx Ethernet Lite (EmacLite) driver. This
driver supports the Xilinx Ethernet Lite 10/100 MAC (EmacLite). The Xilinx
Ethernet Lite 10/100 MAC supports the following features: - Media Independent
Interface (MII) for connection to external 10/100 Mbps PHY transceivers -
Independent internal transmit and receive buffers - CSMA/CD compliant operations
for half-duplex modes - Unicast and broadcast - Automatic FCS insertion -
Automatic pad insertion on transmit - Configurable ping/pong buffers for
either/both transmit and receive buffer areas - Interrupt driven mode - Internal
loop back - MDIO Support to access PHY Registers The Xilinx Ethernet Lite 10/100
MAC does not support the following features: - multi-frame buffering only 1
transmit frame is allowed into each transmit buffer, only 1 receive frame is
allowed into each receive buffer. the hardware blocks reception until buffer is
emptied - Pause frame (flow control) detection in full-duplex mode -
Programmable inter frame gap - Multicast and promiscuous address filtering -
Automatic source address insertion or overwrite <b>Driver Description</b> The
device driver enables higher layer software (e.g., an application) to
communicate to the EmacLite. The driver handles transmission and reception of
Ethernet frames, as well as configuration of the controller. It does not handle
protocol stack functionality such as Link Layer Control (LLC) or the Address
Resolution Protocol (ARP). The protocol stack that makes use of the driver
handles this functionality. This implies that the driver is simply a pass-
through mechanism between a protocol stack and the EmacLite. Since the driver is
a simple pass-through mechanism between a protocol stack and the EmacLite, no
assembly or disassembly of Ethernet frames is done at the driver-level. This
assumes that the protocol stack passes a correctly formatted Ethernet frame to
the driver for transmission, and that the driver does not validate the contents
of an incoming frame. A single device driver can support multiple EmacLite
devices. The driver supports interrupt driven mode and the default mode of
operation is polled mode. If interrupts are desired, XEmacLite_InterruptEnable()
must be called. <b>Device Configuration</b> The device can be configured in
various ways during the FPGA implementation process. Configuration parameters
are stored in the xemaclite_g.c file. A table is defined where each entry
contains configuration information for an EmacLite device. This information
includes such things as the base address of the memory-mapped device and the
number of buffers. <b>Interrupt Processing</b> After _Initialize is called,
_InterruptEnable can be called to enable the interrupt driven functionality. If
polled operation is desired, just call _Send and check the return code. If
XST_FAILURE is returned, call _Send with the same data until XST_SUCCESS is
returned. The same idea applies to _Recv. Call _Recv until the returned length
is non-zero at which point the received data is in the buffer provided in the
function call. The Transmit and Receive interrupts are enabled within the
_InterruptEnable function and disabled in the _InterruptDisable function. The
_Send and _Recv functions acknowledge the EmacLite generated interrupts
associated with each function. It is the application's responsibility to
acknowledge any associated Interrupt Controller interrupts if it is used in the
system. <b>Memory Buffer Alignment</b> The alignment of the input/output buffers
for the _Send and _Recv routine is not required to be 32 bits. If the buffer is
not aligned on a 32-bit boundary there will be a performance impact while the
driver aligns the data for transmission or upon reception. For optimum
performance, the user should provide a 32-bit aligned buffer to the _Send and
_Recv routines. <b>Asserts</b> Asserts are used within all Xilinx drivers to
enforce constraints on argument values. Asserts can be turned off on a system-
wide basis by defining, at compile time, the NDEBUG identifier. By default,
asserts are turned on and it is recommended that application developers leave
asserts on during development. @note This driver requires EmacLite hardware
version 1.01a and higher. It is not compatible with earlier versions of the
EmacLite hardware. Use version 1.00a software driver for hardware version
1.00a/b. The RX hardware is enabled from powerup and there is no disable. It is
possible that frames have been received prior to the initialization of the
driver. If this situation is possible, call XEmacLite_FlushReceive() to empty
the receive buffers after initialization. This driver is intended to be RTOS and
processor independent. It works with physical addresses only. Any needs for
dynamic memory management, threads or thread mutual exclusion, virtual memory,
or cache control must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a ecm
01/30/04 First release 1.11a mta 03/21/07 Updated to new coding style 1.12a mta
11/28/07 Added the function XEmacLite_CfgInitialize, moved the functions
XEmacLite_LookupConfig and XEmacLite_Initialize to xemaclite_sinit.c for
removing the dependency on the static config table and xparameters.h from the
driver initialization 1.13a sv 02/1/08 Updated the TxBufferAvailable routine to
return busy status properly and added macros for Tx/Rx status 1.14a sdm 08/22/08
Removed support for static interrupt handlers from the MDD file 2.00a ktn
02/16/09 Added support for MDIO and internal loop back 2.01a ktn 07/20/09
Updated the XEmacLite_AlignedWrite and XEmacLite_AlignedRead functions to use
volatile variables so that they are not optimized. Modified the
XEmacLite_EnableInterrupts and XEmacLite_DisableInterrupts functions to
enable/disable the interrupt in the Ping buffer as this is used to enable the
interrupts for both Ping and Pong Buffers. The interrupt enable bit in the Pong
buffer is not used by the HW. Modified XEmacLite_Send function to use Ping
buffers Interrupt enable bit since this alone is used to enable the interrupts
for both Ping and Pong Buffers. 3.00a ktn 10/22/09 Updated driver to use the HAL
Processor APIs/macros. The macros have been renamed to remove _m from the name
in all the driver files. The macros changed in this file are
XEmacLite_mNextTransmitAddr is XEmacLite_NextTransmitAddr,
XEmacLite_mNextReceiveAddr is XEmacLite_NextReceiveAddr,
XEmacLite_mIsMdioConfigured is XEmacLite_IsMdioConfigured,
XEmacLite_mIsLoopbackConfigured is XEmacLite_IsLoopbackConfigured. See
xemaclite_i.h for the macros which have changed. 3.01a ktn 07/08/10 The macro
XEmacLite_GetReceiveDataLength in the xemaclite.c file is changed to a static
function. XEmacLite_GetReceiveDataLength and XEmacLite_Recv functions are
updated to support little endian MicroBlaze. 3.02a sdm 07/22/11 Removed
redundant code in XEmacLite_Recv functions for CR617290 3.03a asa 04/05/12
Defined the flag __LITTLE_ENDIAN__ for cases where the driver is compiled with
ARM toolchain. 3.04a srt 04/13/13 Removed warnings (CR 705000). 4.0 adk 19/12/13
Updated as per the New Tcl API's 4.1 nsk 07/13/15 Added Length check in
XEmacLite_AlignedWrite function in xemaclite_l.c file to avoid extra write
operation (CR 843707). 4.2 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototype of XEmacLite_CfgInitialize API. 4.2
adk 11/18/15 Fix compilation errors due to conflicting data types CR917930 4.2
adk 29/02/16 Updated interrupt example to support Zynq and ZynqMP CR938244. 4.3
asa 08/27/16 Fix compilation warning by making change xemaclite_l.c ms 01/23/17
Added xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Modified text file in examples folder for doxygen
generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_g.c @addtogroup
emaclite_v4_4 @{ This file contains a configuration table that specifies the
configuration of EmacLite devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.01a ecm 02/16/04 First release 1.11a mta
03/21/07 Updated to new coding style 2.00a ktn 02/16/09 Added support for MDIO
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_i.h @addtogroup
emaclite_v4_4 @{ This header file contains internal identifiers, which are those
shared between the files of the driver. It is intended for internal use only.
NOTES: None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.01a ecm 05/21/04 First release 1.11a mta 03/21/07 Updated to new
coding style 1.13a sv 02/1/08 Added macros to Get/Set Tx/Rx status 3.00a ktn
10/22/09 The macros have been renamed to remove _m from the name. The macros
changed in this file are XEmacLite_mGetTxActive changed to
XEmacLite_GetTxActive, XEmacLite_mSetTxActive changed to XEmacLite_SetTxActive.
</pre>

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_intr.c @addtogroup
emaclite_v4_4 @{ Functions in this file are for the interrupt driven processing
functionality. See xemaclite.h for a detailed description of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a ecm
03/31/04 First release 1.11a mta 03/21/07 Updated to new coding style 2.01a ktn
07/20/09 Modified the XEmacLite_EnableInterrupts and XEmacLite_DisableInterrupts
functions to enable/disable the interrupt in the Ping buffer as this is used to
enable the interrupts for both Ping and Pong Buffers. The interrupt enable bit
in the Pong buffer is not used by the HW. 3.00a ktn 10/22/09 Updated file to use
the HAL Processor APIs/macros. The macros have been renamed to remove _m from
the name. 4.2 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_l.c @addtogroup
emaclite_v4_4 @{ This file contains the minimal, polled functions to send and
receive Ethernet frames. Refer to xemaclite.h for more details. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm
06/01/02 First release 1.01a ecm 03/31/04 Additional functionality and the
_AlignedRead and _AlignedWrite functions. 1.11a mta 03/21/07 Updated to new
coding style 2.01a ktn 07/20/09 Updated the XEmacLite_AlignedWrite and
XEmacLite_AlignedRead functions to use volatile variables so that they are not
optimized. 3.00a ktn 10/22/09 The macros have been renamed to remove _m from the
name. 4.1 nsk 07/13/15 Added Length check in XEmacLite_AlignedWrite function to
avoid extra write operation (CR 843707). 4.2 sk 11/10/15 Used UINTPTR instead of
u32 for Baseaddress CR 867425. Changed the prototypes of XEmacLite_SendFrame,
XEmacLite_RecvFrame, XEmacLite_AlignedWrite, XEmacLite_AlignedRead APIs. 4.3 asa
08/27/16 Fix compilation warning by making changes in XEmacLite_AlignedWrite.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_l.h @addtogroup
emaclite_v4_4 @{ This header file contains identifiers and basic driver
functions and macros that can be used to access the Xilinx Ethernet Lite 10/100
MAC (EmacLite). Refer to xemaclite.h for more details. @note The functions and
macros in this file assume that the proper device address is provided in the
argument. If the ping buffer is the source or destination, the argument should
be DeviceAddress + XEL_(T/R)XBUFF_OFFSET. If the pong buffer is the source or
destination, the argument should be DeviceAddress + XEL_(T/R)XBUFF_OFFSET +
XEL_BUFFER_OFFSET. The driver does not take the different buffers into
consideration. For more details on the ping/pong buffer configuration please
refer to the Ethernet Lite 10/100 Media Access Controller hardware
specification. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ecm 06/01/02 First release 1.01a ecm 03/31/04 Additional
functionality and the _AlignedRead and AlignedWrite functions. Moved the bulk of
description to xemaclite.h 1.11a mta 03/21/07 Updated to new coding style 2.00a
ktn 02/16/09 Added support for MDIO and internal loop back 3.00a ktn 10/22/09
The macros have been renamed to remove _m from the name. The macros changed in
this file are XEmacLite_mReadReg changed to XEmacLite_mReadReg,
XEmacLite_mWriteReg changed to XEmacLite_mWriteReg, XEmacLite_mGetTxStatus
changed to XEmacLite_GetTxStatus, XEmacLite_mSetTxStatus changed to
XEmacLite_SetTxStatus, XEmacLite_mGetRxStatus changed to XEmacLite_GetRxStatus,
XEmacLite_mSetRxStatus changed to XEmacLite_SetRxStatus, XEmacLite_mIsTxDone
changed to XEmacLite_IsTxDone and XEmacLite_mIsRxEmpty changed to
XEmacLite_IsRxEmpty. 4.2 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress
CR 867425. Changed the prototypes of XEmacLite_SendFrame, XEmacLite_RecvFrame
APIs. </pre>

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_selftest.c
@addtogroup emaclite_v4_4 @{ Function(s) in this file are the required functions
for the EMAC Lite driver sefftest for the hardware. See xemaclite.h for a
detailed description of the driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.01a ecm 01/31/04 First release 1.11a mta 03/21/07
Updated to new coding style 3.00a ktn 10/22/09 Updated driver to use the HAL
Processor APIs/macros. 4.2 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemaclite_sinit.c @addtogroup
emaclite_v4_4 @{ This file contains the implementation of the XEmacLite driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.12a sv 11/28/07 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/emaclite/src/xemaclite_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/22/11 Created 2.0 adk 10/12/13 Updated
as per the New Tcl API's 2.1 adk 11/08/14 Fixed the CR811288 when PCS/PMA core
is present in the hw XPAR_GIGE_PCS_PMA_CORE_PRESENT and phy address values
should export to the xparameters.h file. 2.1 bss 09/08/14 Fixed CR820349 to
export phy address in xparameters.h when GMII to RGMII converter is present in
hw. 2.2 adk 29/10/14 Fixed CR827686 when PCS/PMA core is configured with
1000BASE-X mode export proper values to the xparameters.h file. 3.4 hk 11/22/16
Update how PCS definitions are exported for newer version of Xilinx PCS PMA when
PHY address is not a parameter. 3.5 hk 08/14/17 Export cache coherency
information 3.6 hk 09/14/17 Export PL PCS PMA information for ETH1/2/3 as well.
3.7 hk 12/01/17 Export TSU clock frequency to xparameters.h 3.8 hk 07/19/18
Added canonical property is cache coherency. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/emacps/data/emacps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_example.h Defines
common data types, prototypes, and includes the proper headers for use with the
EMACPS example code residing in this directory. This file along with
xemacps_example_util.c are utilized with the specific example code in the other
source code files provided. These examples are designed to be compiled and
utilized within the SDK standalone BSP development environment. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wsy
01/10/10 First release 1.01a asa 02/27/12 Hash define added for
EMACPS_SLCR_DIV_MASK. 1.05a asa 09/22/13 The EthernetFrame is made cache line
aligned (32 bytes). Fix for CR 663885. 3.0 hk 02/20/15 Increase array sizes to
add support for jumbo frames. 3.2 mus 02//16 Added support support to INTC
controller 3.3 kpc 12/09/16 Fixed issue when -O2 is enabled 3.9 hk 01/23/19
Update versal emulation specific fixes. 03/20/19 Fix alignment pragmas for IAR
compiler. </pre>

FILES:
XilinxProcessorIPLib/drivers/emacps/examples/xemacps_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_example_intr_dma.c
Implements examples that utilize the EmacPs's interrupt driven DMA packet
transfer mode to send and receive frames. These examples demonstrate: - How to
perform simple send and receive. - Interrupt - Error handling - Device reset
Functional guide to example: - EmacPsDmaSingleFrameIntrExample demonstrates the
simplest way to send and receive frames in in interrupt driven DMA mode. -
EmacPsErrorHandler() demonstrates how to manage asynchronous errors. -
EmacPsResetDevice() demonstrates how to reset the driver/HW without losing all
configuration settings. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a wsy 01/10/10 First release 1.00a asa 11/25/11 The cache
disable routines are removed. So now both I-cache and D-cache are enabled. The
array RxBuffer is removed to avoid an extra copy from RxBuffer to RxFrame. Now
the address of RxFrame is submitted to the Rx BD instead of the address of
RxBuffer. In function EmacPsDmaSingleFrameIntrExample, BdRxPtr is made as a
pointer instead of array of pointers. This is done since on the Rx path we now
submit a single BD instead of all 32 BDs. Because of this change, relevant
changes are made throughout the function EmacPsDmaSingleFrameIntrExample. Cache
invalidation is now being done for the RxFrame buffer. The unnecessary cache
flush (Xil_DCacheFlushRange) is removed. This was being done towards the end of
the example which was unnecessary. 1.00a asa 01/24/12 Support for Zynq board is
added. The SLCR divisors are different for Zynq. Changes are made for the same.
Presently the SLCR GEM clock divisors are hard-coded assuming that IO PLL output
frequency is 1000 MHz. The BDs are allocated at the address 0xFF00000 and the 1
MB address range starting from this address is made uncached. This is because,
for GEM the BDs need to be placed in uncached memory. The RX BDs are allocated
at address 0xFF00000 and TX BDs are allocated at address 0xFF10000. The MDIO
divisor used of 224 is used for Zynq board. 1.01a asa 02/27/12 The hardcoded
SLCR divisors for Zynq are removed. The divisors are obtained from
xparameters.h.c. The sleep values are reduced for Zynq. One sleep is added after
MDIO divisor is set. Some of the prints are removed. 1.01a asa 03/14/12 The SLCR
divisor support for ENET1 is added. 1.01a asa 04/15/12 The funcation calls to
Xil_DisableMMU and Xil_EnableMMU are removed for setting the translation table
attributes for the BD memory region. 1.05a asa 09/22/13 Cache handling is
changed to fix an issue (CR663885). The cache invalidation of the Rx frame is
now moved to XEmacPsRecvHandler so that invalidation happens after the received
data is available in the memory. The variable TxFrameLength is now made global.
2.1 srt 07/11/14 Implemented 64-bit changes and modified as per Zynq Ultrascale
Mp GEM specification 3.0 kpc 01/23/14 Removed PEEP board related code 3.0 hk
03/18/15 Added support for jumbo frames. Add cache flush after BD terminate
entries. 3.2 hk 10/15/15 Added clock control using CRL_APB_GEM_REF_CTRL
register. Enabled 1G speed for ZynqMP GEM. Select GEM interrupt based on
instance present. Manage differences between emulation platform and silicon. 3.2
mus 20/02/16.Added support for INTC interrupt controlller. Added support to
access zynq emacps interrupt from microblaze. 3.3 kpc 12/09/16 Fixed issue when
-O2 is enabled 3.4 ms 01/23/17 Modified xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. 3.5 hk 08/14/17 Don't perform data cache
operations when CCI is enabled on ZynqMP. 3.8 hk 10/01/18 Fix warning for
redefinition of interrupt number. 3.9 hk 02/12/19 Change MDC divisor for Versal
emulation. 03/06/19 Fix BD space assignment and its memory attributes. 03/20/19
Fix alignment pragmas for IAR compiler. 3.10 hk 05/17/19 Use correct platform
register for Versal. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/examples/xemacps_example_intr_dma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_example_util.c This
file implements the utility functions for the XEmacPs example code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wsy
01/10/10 First release 1.00a asa 01/24/12 A new version of
EmacPsUtilEnterLoopback is used for Zynq boards. Now there are two versions of
EmacPsUtilEnterLoopback, one for PEEP and one for Zynq. If the example is to be
run on a PEEP board, define PEEP in xemacps_example.h. 1.01a asa 02/27/12 The
sleep value after PHY loopback is setup is reduced for Zynq. 3.0 kpc 01/23/15
Removed PEEP board related code 3.2 hk 09/30/15 Added support for TI PHY DP83867
3.2 mus 02/20/16 Added support for microblaze. 3.9 hk 02/12/19 Use selected
speed in loopback mode. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/examples/xemacps_example_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_ieee1588.c This file
implements the following functionalities. - Contains a routine upon reception of
Tx done ISR to store the time stamp of the transmitted packet. - Does formatting
and initiates a Tx for Announce frame, Sync frame, FollowUp frame, PDelayReq,
PDelayResp and PDelayRespFollowUp frames. - Decodes and processes the received
PTP frames of type Sync Frame, FollowUp frame, Announce Frame, PDelayReq frame,
PDelayResp frame and PDelayRespFollowUp frame. - Implements the best master
clock algorithm. - Contains function that calculates the link delay from
existing data. - Contains function that calculates the clock offset from
existing data and applies the clock offset to correct the PTP clock. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa
09/16/11 First release based on the AVB driver. 1.01a asa 03/03/12 Support for
Zynq is added. 3.3 asa 05/19/16 Removed code specific to PEEP. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/examples/xemacps_ieee1588.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_ieee1588.h Defines hash
defines, common data types and prototypes to be used with the PTP standalone
example source code residing in this directory. The PTP standalone example files
implement the basic PTPv2 protocol as an example application. However the
accuracy of clock offset adjustment is not guaranteed as of now. Also the clock
rate adjustment and signalling frames are not implemented. Also it may not be
implementing all aspects of PTPv2 strictly as per specs. Since it is based on
AVB driver (which is 802.1as based), some aspects of 802.1as which are not there
in IEEE1588 may be there in the protocol implementation inadvertently. The sync
frame interval, announce frame interval and PDelayReq frame intervals are hard-
coded. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a asa 09/16/11 First release based on AVB driver 1.01a asa 03/03/12 New
hashdefines are added and new function prototypes are added. 3.3 asa 05/19/16
Fix for CR951152. Made following changes. - Removed code specific for PEEP. -
Ensured that each buffer in RxBuf array is cache line aligned. The Rxbuf array
itself is made cache line aligned. - The XEMACPS_PACKET_LEN is changed from 1538
to 1598. Though the packet length can never be 1598 for non-jumbo ethernet
packets, it is changes to ensure that each Rx buffer becomes cache line aligned.
If a Rx buffer is not cache line aligned, the A9 based invalidation logic
flushes the first cache line to ensure that other data faling in this cache line
are not lost when the buffer in invalidated upon reception of a packet. But that
will also mean the data received in this cache line is lost. By making this
change we always ensure that when an invalidation happens no flushing takes
place and no incoming data is lost. - Changes made not to disable and enable
back the MMU when we change the attribute of BD space to make it strongly
ordered. - The number of Rx and Tx bufs are changed from 32 to 16 as for this
simple example so many BDs will never be needed. </pre>

FILES:
XilinxProcessorIPLib/drivers/emacps/examples/xemacps_ieee1588.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_ieee1588_example.c This
is top level c file for the IEEE1588 (PTP) standalone example. It has the
following functionalities. It uses SCUTimer to transmit PTP packets at regular
intervals. - Contains the main routine for the PTP protocol example. -
Initializes the SCUGIC, SCUTimer - Initializes the EmacPs hardware for packet
transfer. - Initializes the buffer descriptors for the PTP packet transfer. -
Initializes and handles the buffers that receive the PTP packets and whose
address goes in the buffer descriptors. - Contains the interrupt handlers for
Ethernet Tx and Ethernet Rx. - Contains the Timer interrupt handlers. -
Implements the top level state machine for the PTP protocol. - Contains routines
that initiate the PTP Tx. - Initializes the some fields in the PTP Tx packets.
These fields are fixed and its entries do not change with time. - Contains
various helper routines, e.g. routines for endian conversion. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a asa 09/16/11 First
release based on the AVB driver. 1.01a asa 03/03/12 Support for Zynq is added.
BD handling is changed. 3.3 asa 05/19/16 Fix for CR951152. Made following
changes. - Removed code specific for PEEP. - Ensured that each buffer in RxBuf
array is cache line aligned. The Rxbuf array itself is made cache line aligned.
- The XEMACPS_PACKET_LEN is changed from 1538 to 1598. Though the packet length
can never be 1598 for non-jumbo ethernet packets, it is changes to ensure that
each Rx buffer becomes cache line aligned. If a Rx buffer is not cache line
aligned, the A9 based invalidation logic flushes the first cache line to ensure
that other data faling in this cache line are not lost when the buffer in
invalidated upon reception of a packet. But that will also mean the data
received in this cache line is lost. By making this change we always ensure that
when an invalidation happens no flushing takes place and no incoming data is
lost. - Changes made not to disable and enable back the MMU when we change the
attribute of BD space to make it strongly ordered. ms 04/05/17 Added tabspace
for return statements in functions for proper documentation while generating
doxygen. 3.9 hk 03/20/19 Fix alignment pragmas for IAR compiler. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/examples/xemacps_ieee1588_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps.c @addtogroup
emacps_v3_10 @{ The XEmacPs driver. Functions in this file are the minimum
required functions for this driver. See xemacps.h for a detailed description of
the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a wsy 01/10/10 First release 2.1 srt 07/15/14 Add support for Zynq
Ultrascale Mp GEM specification and 64-bit changes. 3.00 kvn 02/13/15 Modified
code for MISRA-C:2012 compliance. 3.0 hk 02/20/15 Added support for jumbo
frames. Increase AHB burst. Disable extended mode. Perform all 64 bit changes
under check for arch64. 3.1 hk 08/10/15 Update upper 32 bit tx and rx queue ptr
registers 3.5 hk 08/14/17 Update cache coherency information of the interface in
its config structure. 3.8 hk 09/17/18 Cleanup stale comments. 3.8 mus 11/05/18
Support 64 bit DMA addresses for Microblaze-X platform. 3.10 hk 05/16/19 Clear
status registers properly in reset </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps.h @addtogroup
emacps_v3_10 @{ @details The Xilinx Embedded Processor Block Ethernet driver.
For a full description of XEMACPS features, please see the hardware spec. This
driver supports the following features: - Memory mapped access to host interface
registers - Statistics counter registers for RMON/MIB - API for interrupt driven
frame transfers for hardware configured DMA - Virtual memory support - Unicast,
broadcast, and multicast receive address filtering - Full and half duplex
operation - Automatic PAD & FCS insertion and stripping - Flow control - Support
up to four 48bit addresses - Address checking for four specific 48bit addresses
- VLAN frame support - Pause frame support - Large frame support up to 1536
bytes - Checksum offload <b>Driver Description</b> The device driver enables
higher layer software (e.g., an application) to communicate to the XEmacPs. The
driver handles transmission and reception of Ethernet frames, as well as
configuration and control. No pre or post processing of frame data is performed.
The driver does not validate the contents of an incoming frame in addition to
what has already occurred in hardware. A single device driver can support
multiple devices even when those devices have significantly different
configurations. <b>Initialization & Configuration</b> The XEmacPs_Config
structure is used by the driver to configure itself. This configuration
structure is typically created by the tool-chain based on hardware build
properties. The driver instance can be initialized in -
XEmacPs_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddress): Uses a
configuration structure provided by the caller. If running in a system with
address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. The device supports DMA
only as current development plan. No FIFO mode is supported. The driver expects
to start the DMA channels and expects that the user has set up the buffer
descriptor lists. <b>Interrupts and Asynchronous Callbacks</b> The driver has no
dependencies on the interrupt controller. When an interrupt occurs, the handler
will perform a small amount of housekeeping work, determine the source of the
interrupt, and call the appropriate callback function. All callbacks are
registered by the user level application. <b>Virtual Memory</b> All virtual to
physical memory mappings must occur prior to accessing the driver API. For DMA
transactions, user buffers supplied to the driver must be in terms of their
physical address. <b>DMA</b> The DMA engine uses buffer descriptors (BDs) to
describe Ethernet frames. These BDs are typically chained together into a list
the hardware follows when transferring data in and out of the packet buffers.
Each BD describes a memory region containing either a full or partial Ethernet
packet. Interrupt coalescing is not supported from this built-in DMA engine.
This API requires the user to understand how the DMA operates. The following
paragraphs provide some explanation, but the user is encouraged to read
documentation in xemacps_bdring.h as well as study example code that accompanies
this driver. The API is designed to get BDs to and from the DMA engine in the
most efficient means possible. The first step is to establish a memory region to
contain all BDs for a specific channel. This is done with
XEmacPs_BdRingCreate(). This function sets up a BD ring that hardware will
follow as BDs are processed. The ring will consist of a user defined number of
BDs which will all be partially initialized. For example on the transmit
channel, the driver will initialize all BDs' so that they are configured for
transmit. The more fields that can be permanently setup at initialization, then
the fewer accesses will be needed to each BD while the DMA engine is in
operation resulting in better throughput and CPU utilization. The best case
initialization would require the user to set only a frame buffer address and
length prior to submitting the BD to the engine. BDs move through the engine
with the help of functions XEmacPs_BdRingAlloc(), XEmacPs_BdRingToHw(),
XEmacPs_BdRingFromHw(), and XEmacPs_BdRingFree(). All these functions handle BDs
that are in place. That is, there are no copies of BDs kept anywhere and any BD
the user interacts with is an actual BD from the same ring hardware accesses.
BDs in the ring go through a series of states as follows: 1. Idle. The driver
controls BDs in this state. 2. The user has data to transfer.
XEmacPs_BdRingAlloc() is called to reserve BD(s). Once allocated, the user may
setup the BD(s) with frame buffer address, length, and other attributes. The
user controls BDs in this state. 3. The user submits BDs to the DMA engine with
XEmacPs_BdRingToHw. BDs in this state are either waiting to be processed by
hardware, are in process, or have been processed. The DMA engine controls BDs in
this state. 4. Processed BDs are retrieved with XEmacEpv_BdRingFromHw() by the
user. Once retrieved, the user can examine each BD for the outcome of the DMA
transfer. The user controls BDs in this state. After examining the BDs the user
calls XEmacPs_BdRingFree() which places the BDs back into state 1. Each of the
four BD accessor functions operate on a set of BDs. A set is defined as a
segment of the BD ring consisting of one or more BDs. The user views the set as
a pointer to the first BD along with the number of BDs for that set. The set can
be navigated by using macros XEmacPs_BdNext(). The user must exercise extreme
caution when changing BDs in a set as there is nothing to prevent doing a
mBdNext past the end of the set and modifying a BD out of bounds.
XEmacPs_BdRingAlloc() + XEmacPs_BdRingToHw(), as well as XEmacPs_BdRingFromHw()
+ XEmacPs_BdRingFree() are designed to be used in tandem. The same BD set
retrieved with BdRingAlloc should be the same one provided to hardware with
BdRingToHw. Same goes with BdRingFromHw and BdRIngFree. <b>Alignment & Data
Cache Restrictions</b> Due to the design of the hardware, all RX buffers, BDs
need to be 4-byte aligned. Please reference xemacps_bd.h for cache related
macros. DMA Tx: - If frame buffers exist in cached memory, then they must be
flushed prior to committing them to hardware. DMA Rx: - If frame buffers exist
in cached memory, then the cache must be invalidated for the memory region
containing the frame prior to data access Both cache invalidate/flush are taken
care of in driver code. <b>Buffer Copying</b> The driver is designed for a zero-
copy buffer scheme. That is, the driver will not copy buffers. This avoids
potential throughput bottlenecks within the driver. If byte copying is required,
then the transfer will take longer to complete. <b>Checksum Offloading</b> The
Embedded Processor Block Ethernet can be configured to perform IP, TCP and UDP
checksum offloading in both receive and transmit directions. IP packets contain
a 16-bit checksum field, which is the 16-bit 1s complement of the 1s complement
sum of all 16-bit words in the header. TCP and UDP packets contain a 16-bit
checksum field, which is the 16-bit 1s complement of the 1s complement sum of
all 16-bit words in the header, the data and a conceptual pseudo header. To
calculate these checksums in software requires each byte of the packet to be
read. For TCP and UDP this can use a large amount of processing power.
Offloading the checksum calculation to hardware can result in significant
performance improvements. The transmit checksum offload is only available to use
DMA in packet buffer mode. This is because the complete frame to be transmitted
must be read into the packet buffer memory before the checksum can be calculated
and written to the header at the beginning of the frame. For IP, TCP or UDP
receive checksum offload to be useful, the operating system containing the
protocol stack must be aware that this offload is available so that it can make
use of the fact that the hardware has verified the checksum. When receive
checksum offloading is enabled in the hardware, the IP header checksum is
checked, where the packet meets the following criteria: 1. If present, the VLAN
header must be four octets long and the CFI bit must not be set. 2.
Encapsulation must be RFC 894 Ethernet Type Encoding or RFC 1042 SNAP encoding.
3. IP v4 packet. 4. IP header is of a valid length. 5. Good IP header checksum.
6. No IP fragmentation. 7. TCP or UDP packet. When an IP, TCP or UDP frame is
received, the receive buffer descriptor gives an indication if the hardware was
able to verify the checksums. There is also an indication if the frame had SNAP
encapsulation. These indication bits will replace the type ID match indication
bits when the receive checksum offload is enabled. If any of the checksums are
verified incorrect by the hardware, the packet is discarded and the appropriate
statistics counter incremented. <b>PHY Interfaces</b> RGMII 1.3 is the only
interface supported. <b>Asserts</b> Asserts are used within all Xilinx drivers
to enforce constraints on parameters. Asserts can be turned off on a system-wide
basis by defining, at compile time, the NDEBUG identifier. By default, asserts
are turned on and it is recommended that users leave asserts on during
development. For deployment use -DNDEBUG compiler switch to remove assert code.
@note Xilinx drivers are typically composed of two parts, one is the driver and
the other is the adapter. The driver is independent of OS and processor and is
intended to be highly portable. The adapter is OS-specific and facilitates
communication between the driver and an OS. This driver is intended to be RTOS
and processor independent. Any needs for dynamic memory management, threads or
thread mutual exclusion, or cache control must be satisfied bythe layer above
this driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a wsy 01/10/10 First release 1.00a asa 11/21/11 The function
XEmacPs_BdRingFromHwTx in file xemacps_bdring.c is modified. Earlier it was
checking for "BdLimit"(passed argument) number of BDs for finding out which BDs
are successfully processed. Now one more check is added. It looks for BDs till
the current BD pointer reaches HwTail. By doing this processing time is saved.
1.00a asa 01/24/12 The function XEmacPs_BdRingFromHwTx in file xemacps_bdring.c
is modified. Now start of packet is searched for returning the number of BDs
processed. 1.02a asa 11/05/12 Added a new API for deleting an entry from the
HASH registers. Added a new API to set the bust length. Added some new hash-
defines. 1.03a asa 01/23/12 Fix for CR 692702 which updates error handling for
Rx errors. Under heavy Rx traffic, there will be a large number of errors
related to receive buffer not available. Because of a HW bug (SI 692601), under
such heavy errors, the Rx data path can become unresponsive. To reduce the
probabilities for hitting this HW bug, the SW writes to bit 18 to flush a packet
from Rx DPRAM immediately. The changes for it are done in the function
XEmacPs_IntrHandler. 1.05a asa 09/23/13 Cache operations on BDs are not required
and hence removed. It is expected that all BDs are allocated in from uncached
area. 1.06a asa 11/02/13 Changed the value for XEMACPS_RXBUF_LEN_MASK from
0x3fff to 0x1fff. This fixes the CR744902. Made changes in example file
xemacps_example.h to fix compilation issues with iarcc compiler. 2.0 adk
10/12/13 Updated as per the New Tcl API's 2.1 adk 11/08/14 Fixed the CR811288.
Changes are made in the driver tcl file. 2.1 bss 09/08/14 Modified driver tcl to
fix CR820349 to export phy address in xparameters.h when GMII to RGMII converter
is present in hw. 2.1 srt 07/15/14 Add support for Zynq Ultrascale Mp GEM
specification and 64-bit changes. 2.2 adk 29/10/14 Fixed CR827686 when PCS/PMA
core is configured with 1000BASE-X mode export proper values to the
xparameters.h file. Changes are made in the driver tcl file. 3.0 adk 08/1/15
Don't include gem in peripheral test when gem is configured with PCS/PMA Core.
Changes are made in the test app tcl(CR:827686). 3.0 kvn 02/13/15 Modified code
for MISRA-C:2012 compliance. 3.0 hk 03/18/15 Added support for jumbo frames.
Increase AHB burst. Disable extended mode. Perform all 64 bit changes under
check for arch64. Remove "used bit set" from TX error interrupt masks. 3.1 hk
07/27/15 Do not call error handler with '0' error code when there is no error.
CR 869403 08/10/15 Update upper 32 bit tx and rx queue ptr registers. 3.2 hk
02/22/16 Added SGMII support for Zynq Ultrascale+ MPSoC. 3.4 ms 01/23/17
Modified xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Modified text file in examples folder for doxygen
generation. ms 04/05/17 Added tabspace for return statements in functions of
xemacps_ieee1588_example.c for proper documentation while generating doxygen.
3.5 hk 08/14/17 Update cache coherency information of the interface in its
config structure. 3.6 rb 09/08/17 HwCnt variable (in XEmacPs_BdRing structure)
is changed to volatile. Add API XEmacPs_BdRingPtrReset() to reset pointers 3.8
hk 07/19/18 Fixed CPP, GCC and doxygen warnings - CR-1006327 hk 09/17/18 Fix PTP
interrupt masks and cleanup comments. 3.9 hk 01/23/19 Add RX watermark support
</pre> /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_bd.h @addtogroup
emacps_v3_10 @{ This header provides operations to manage buffer descriptors in
support of scatter-gather DMA. The API exported by this header defines
abstracted macros that allow the user to read/write specific BD fields.
<b>Buffer Descriptors</b> A buffer descriptor (BD) defines a DMA transaction.
The macros defined by this header file allow access to most fields within a BD
to tailor a DMA transaction according to user and hardware requirements. See the
hardware IP DMA spec for more information on BD fields and how they affect
transfers. The XEmacPs_Bd structure defines a BD. The organization of this
structure is driven mainly by the hardware for use in scatter-gather DMA
transfers. <b>Performance</b> Limiting I/O to BDs can improve overall
performance of the DMA channel. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a wsy 01/10/10 First release 2.1 srt 07/15/14 Add
support for Zynq Ultrascale MP GEM specification and 64-bit changes. 3.0 kvn
02/13/15 Modified code for MISRA-C:2012 compliance. 3.0 hk 02/20/15 Added
support for jumbo frames. Disable extended mode. Perform all 64 bit changes
under check for arch64. 3.2 hk 11/18/15 Change BD typedef and number of words.
3.8 hk 08/18/18 Remove duplicate definition of XEmacPs_BdSetLength 3.8 mus
11/05/18 Support 64 bit DMA addresses for Microblaze-X platform. </pre> /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_bd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_bdring.c @addtogroup
emacps_v3_10 @{ This file implements buffer descriptor ring related functions.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wsy
01/10/10 First release 1.00a asa 11/21/11 The function XEmacPs_BdRingFromHwTx is
modified. Earlier it used to search in "BdLimit" number of BDs to know which BDs
are processed. Now one more check is added. It looks for BDs till the current BD
pointer reaches HwTail. By doing this processing time is saved. 1.00a asa
01/24/12 The function XEmacPs_BdRingFromHwTx in file xemacps_bdring.c is
modified. Now start of packet is searched for returning the number of BDs
processed. 1.05a asa 09/23/13 Cache operations on BDs are not required and hence
removed. It is expected that all BDs are allocated in from uncached area. Fix
for CR 663885. 2.1 srt 07/15/14 Add support for Zynq Ultrascale Mp architecture.
3.0 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.6 rb 09/08/17 Add
XEmacPs_BdRingPtrReset() API to reset BD ring pointers </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_bdring.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_bdring.h @addtogroup
emacps_v3_10 @{ The Xiline EmacPs Buffer Descriptor ring driver. This is part of
EmacPs DMA functionalities. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a wsy 01/10/10 First release 2.1 srt 07/15/14 Add
support for Zynq Ultrascale Mp architecture. 3.0 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. 3.6 rb 09/08/17 HwCnt variable (in XEmacPs_BdRing
structure) is changed to volatile. </pre>

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_bdring.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_control.c @addtogroup
emacps_v3_10 @{ Functions in this file implement general purpose command and
control related functionality. See xemacps.h for a detailed description of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a wsy 01/10/10 First release 1.02a asa 11/05/12 Added a new API for deleting
an entry from the HASH register. Added a new API for setting the BURST length in
DMACR register. 2.1 srt 07/15/14 Add support for Zynq Ultrascale Mp
architecture. 3.0 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.0 hk
02/20/15 Added support for jumbo frames. 3.2 hk 02/22/16 Added SGMII support for
Zynq Ultrascale+ MPSoC. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_control.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_g.c @addtogroup
emacps_v3_10 @{ This file contains a configuration table that specifies the
configuration of ethernet devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a wsy 01/10/10 First release 2.00 hk
22/01/14 Added check for picking second instance 3.00 kvn 02/13/15 Modified code
for MISRA-C:2012 compliance. </pre> @internal This configuration table contains
entries that are modified at runtime by the driver. This table reflects only the
hardware configuration of the device. This emac configuration table contains
software information in addition to hardware configuration. Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_hw.c @addtogroup
emacps_v3_10 @{ This file contains the implementation of the ethernet interface
reset sequence <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.05a kpc 28/06/13 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_hw.h @addtogroup
emacps_v3_10 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the PS Ethernet MAC (XEmacPs)
device. High-level driver functions are defined in xemacps.h. @note <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wsy
01/10/10 First release. 1.02a asa 11/05/12 Added hash defines for DMACR burst
length configuration. 1.05a kpc 28/06/13 Added XEmacPs_ResetHw function
prototype 1.06a asa 11/02/13 Changed the value for XEMACPS_RXBUF_LEN_MASK from
0x3fff to 0x1fff. This fixes the CR744902. 2.1 srt 07/15/14 Add support for Zynq
Ultrascale Mp GEM specification. 3.0 kvn 12/16/14 Changed name of
XEMACPS_NWCFG_LENGTHERRDSCRD_MASK to XEMACPS_NWCFG_LENERRDSCRD_MASK as it
exceeds 31 characters. 3.0 kpc 1/23/15 Corrected the extended descriptor macro
values. 3.0 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.0 hk
03/18/15 Added support for jumbo frames. Remove "used bit set" from TX error
interrupt masks. 3.1 hk 08/10/15 Update upper 32 bit tx and rx queue ptr
register offsets. 3.2 hk 02/22/16 Added SGMII support for Zynq Ultrascale+
MPSoC. 3.8 hk 09/17/18 Fix PTP interrupt masks. 3.9 hk 01/23/19 Add RX watermark
support 3.10 hk 05/16/19 Clear status registers properly in reset </pre>

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_intr.c @addtogroup
emacps_v3_10 @{ Functions in this file implement general purpose interrupt
processing related functionality. See xemacps.h for a detailed description of
the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a wsy 01/10/10 First release 1.03a asa 01/24/13 Fix for CR 692702 which
updates error handling for Rx errors. Under heavy Rx traffic, there will be a
large number of errors related to receive buffer not available. Because of a HW
bug (SI 692601), under such heavy errors, the Rx data path can become
unresponsive. To reduce the probabilities for hitting this HW bug, the SW writes
to bit 18 to flush a packet from Rx DPRAM immediately. The changes for it are
done in the function XEmacPs_IntrHandler. 2.1 srt 07/15/14 Add support for Zynq
Ultrascale Mp GEM specification and 64-bit changes. 3.0 kvn 02/13/15 Modified
code for MISRA-C:2012 compliance. 3.1 hk 07/27/15 Do not call error handler with
'0' error code when there is no error. CR 869403 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemacps_sinit.c @addtogroup
emacps_v3_10 @{ This file contains lookup method by device ID when success, it
returns pointer to config table to be used to initialize the device. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wsy
01/10/10 New 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/emacps/src/xemacps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 10/12/13 Removed support for
opb_emc_v2_00_a plb_emc mch_opb_emc xps_mch_emc

FILES:
XilinxProcessorIPLib/drivers/emc/data/emc.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- sdm 10/29/08 Added code to generate canonicals for
EMC. sdm 05/12/10 Added code for generating defines in xparameters.h to
distinguish between XPS_MCH_EMC and AXI_EMC. These defines are used by the
Xil_Flash Library 4.0 adk 10/12/13 Updated as per the New Tcl API's uses
"xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/emc/data/emc.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_I - Add a new argument to gen_include_files.
@END_CHANGELOG @BEGIN_CHANGELOG EDK_H - Added support for generation of multiple
applications. All TCL procedures are now required to have a software project
type as its first argument @END_CHANGELOG @BEGIN_CHANGELOG EDK_M - HAL phase 1
migration to use new test memory functions. @END_CHANGELOG Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/emc/data/emc_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xemc.h @addtogroup emc_v4_0 @{
@details This driver exists only to allow the EDK tools to create a memory test
application and to populate xparameters.h with memory range constants. There is
no source code. MODIFICATION HISTORY: VER WHO DATE NOTES 4.0 adk 19/12/13
Updated as per the New Tcl API's @} /

FILES:
XilinxProcessorIPLib/drivers/emc/src/xemc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ----- ---------- 7.0 adk 02/19/14 First release. 7.1 ms 01/31/17
Updated the parameter naming from XPAR_ENHANCE_NUM_INSTANCES to
XPAR_XENHANCE_NUM_INSTANCES to avoid compilation failure for
XPAR_ENHANCE_NUM_INSTANCES as the tools are generating
XPAR_XENHANCE_NUM_INSTANCES in the generated xenhance_g.c for fixing MISRA-C
files. This is a fix for CR-967548 based on the update in the tools.

FILES:
XilinxProcessorIPLib/drivers/enhance/data/enhance.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file enhance_selftest_example.c This
file contains an example using the XEnhance driver to do self test on the
device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00a drg/jz 01/13/10 First Release 1.03a sg 08/14/12 Updated the example for CR
666306. Modified the device ID to use the first Device Id Removed the printf at
the start of the main 7.0 adk 02/19/14 Modified function names as per guidelines
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/enhance/examples/enhance_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenhance.c @addtogroup
enhance_v7_1 @{ This file contains the implementation of the interface functions
for Enhance core. Refer to the header file xenhance.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
2.00a vc 12/14/10 Updated for ENHANCE V2.0 3.00a rc 09/11/11 Updated for ENHANCE
V3.0 4.00a vyc 04/24/12 Updated for ENHANCE V4.00.a Converted from xio.h to
xil_io.h, translating basic type, MB cache functions, exceptions and assertion
to xil_io format. 5.00a vyc 06/19/13 Updated for ENHANCE V8.0 New edge
enhancement algorithm and registers Noise reduction support added 6.0 adk
19/12/13 Updated as per the New Tcl API's 7.0 adk 02/19/14 Changed the filename
from enhance.c to xenhance.c. Modified the following functions
XENHANCE_CfgInitialize -> XEnhance_CfgInitialize XENHANCE_Setup ->
XEnhance_Setup Implemented the following functions: XEnhance_GetVersion,
XEnhance_EnableDbgByPass XEnhance_IsDbgByPassEnabled, XEnhance_DisableDbgBypass
XEnhance_EnableDbgTestPattern, XEnhance_IsDbgTestPatternEnabled
XEnhance_DisableDbgTestPattern XEnhance_GetDbgFrameCount,
XEnhance_GetDbgLineCount, XEnhance_GetDbgPixelCount, XEnhance_SetActiveSize,
XEnhance_GetActiveSize, XEnhance_SetNoiseThreshold, XEnhance_GetNoiseThreshold,
XEnhance_SetEdgeStrength, XEnhance_GetEdgeStrength, XEnhance_SetHaloSuppress
XEnhance_GetHaloSuppress. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/enhance/src/xenhance.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenhance.h @addtogroup
enhance_v7_1 @{ @details This header file contains identifiers and register-
level driver functions (or macros), range macros, structure typedefs that can be
used to access the Image Statistic core instance. The Image Enhancement core
offers noise reduction and/or edge enhancement. For edge enhancement, optional
anti-halo and anti-alias post-processing modules are available to reduce image
artifacts that can appear from the high-pass filtering of the edge enhancement
filters. The amount of noise reduction and edge enhancement is controlled
through user parameters. There are two variations of the algorithm offered to
choose between high performance and minimal resource usage. This core works on
YCbCr 4:4:4 and 4:2:2 data. The core is capable of a maximum resolution of 7680
columns by 7680 rows with 8, 10, 12, or 16 bits per pixel and supports the
bandwidth necessary for High-definition (1080p60) resolutions in all Xilinx FPGA
device families. Higher resolutions can be supported in Xilinx high-performance
device families. <b>Initialization & Configuration</b> The device driver enables
higher layer software (e.g., an application) to communicate to the Enhance core.
XEnhance_CfgInitialize() API is used to initialize the Enhance core. The user
needs to first call the XEnhance_LookupConfig() API which returns the
Configuration structure pointer which is passed as a parameter to the
XEnhance_CfgInitialize() API. <b> Interrupts </b> The driver provides an
interrupt handler XEnhance_IntrHandler for handling the interrupt from the
Enhance core. The users of this driver have to register this handler with the
interrupt system and provide the callback functions by using
XEnhance_SetCallBack API. <b> Virtual Memory </b> This driver supports Virtual
Memory. The RTOS is responsible for calculating the correct device base address
in Virtual Memory space. <b> Threads </b> This driver is not thread safe. Any
needs for threads or thread mutual exclusion must be satisfied by the layer
above this driver. <b> Asserts </b> Asserts are used within all Xilinx drivers
to enforce constraints on argument values. Asserts can be turned off on a
system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The XEnhance driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 2.00a vc 12/14/10 Updated for ENHANCE V2.0 3.00a rc
09/11/11 Updated for ENHANCE V3.0 4.00a vyc 04/24/12 Updated for ENHANCE V4.00.a
Converted from xio.h to xil_io.h, translating basic type, MB cache functions,
exceptions and assertion to xil_io format. 5.00a vyc 06/19/13 Updated for
ENHANCE V8.0 New edge enhancement algorithm and registers Noise reduction
support added 6.0 adk 19/12/13 Updated as per the New Tcl API's 7.0 adk 02/19/14
Changed the filename from enhance.h to xenhance.h. Changes in xenhance.h:
Removed the following macros ENHANCE_Enable, ENHANCE_Disable,
ENHANCE_RegUpdateEnable, ENHANCE_RegUpdateDisable, ENHANCE_Reset,
ENHANCE_AutoSyncReset Added the following function macros XEnhance_Enable,
XEnhance_Disable, XEnhance_RegUpdateDisable, XEnhance_RegUpdateDisable
XEnhance_Reset, XEnhance_SyncReset, XEnhance_IntrEnable XEnhance_IntrDisable,
XEnhance_StatusGetPending XEnhance_IntrGetPending, XEnhance_IntrClear Added the
following type definitions: XEnhance_Config and XEnhance structures.
XEnhance_CallBack and XEnhance_ErrorCallBack. Changes in xenhance.c: Modified
the following functions XENHANCE_CfgInitialize -> XEnhance_CfgInitialize
XENHANCE_Setup -> XEnhance_Setup Implemented the following functions:
XEnhance_CfgInitialize, XEnhance_Setup, XEnhance_GetVersion,
XEnhance_EnableDbgByPass, XEnhance_IsDbgByPassEnabled, XEnhance_DisableDbgBypass
XEnhance_EnableDbgTestPattern, XEnhance_IsDbgTestPatternEnabled
XEnhance_DisableDbgTestPattern XEnhance_GetDbgFrameCount,
XEnhance_GetDbgLineCount, XEnhance_GetDbgPixelCount, XEnhance_SetActiveSize,
XEnhance_GetActiveSize, XEnhance_SetNoiseThreshold, XEnhance_GetNoiseThreshold,
XEnhance_SetEdgeStrength, XEnhance_GetEdgeStrength, XEnhance_SetHaloSuppress
XEnhance_GetHaloSuppress. Changes in xenhance_hw.h: Added the register offsets
and bit masks for the registers and added backward compatibility for macros.
Changes in xenhance_intr.c: Implemented the following functions
XEnhance_IntrHandler XEnhance_SetCallBack Changes in xenhance_sinit.c:
Implemented the following function XEnhance_LookupConfig Changes in
xenhance_selftest.c: Implemented the following function XEnhance_SelfTest 7.1 ms
01/31/17 Updated the parameter naming from XPAR_ENHANCE_NUM_INSTANCES to
XPAR_XENHANCE_NUM_INSTANCES to avoid compilation failure for
XPAR_ENHANCE_NUM_INSTANCES as the tools are generating
XPAR_XENHANCE_NUM_INSTANCES in the generated xenhance_g.c for fixing MISRA-C
files. This is a fix for CR-967548 based on the update in the tools. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/enhance/src/xenhance.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenhance_hw.h @addtogroup
enhance_v7_1 @{ This header file contains identifiers and register-level driver
functions (or macros) that can be used to access the Xilinx Video Image
Enhancement core. For more information about the operation of this core, see the
hardware specification and documentation in the higher level driver xenhance.h
source code file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 7.0 adk 01/07/14 First release. Added the register offsets and bit
masks for the registers and added backward compatibility for macros. </pre>

FILES:
XilinxProcessorIPLib/drivers/enhance/src/xenhance_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenhance_intr.c @addtogroup
enhance_v7_1 @{ This code contains interrupt related functions of Xilinx Enhance
core. Please see xenhance.h for more details of the core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 7.0 adk 02/19/14 First release.
Implemented the following functions XEnhance_IntrHandler XEnhance_SetCallBack
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/enhance/src/xenhance_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenhance_selftest.c @addtogroup
enhance_v7_1 @{ This file contains the self-test functions for the Enhance
driver. The self test function reads the Version register. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 7.0 adk 19/02/14 First
Release. Implemented the following function XEnhance_SelfTest </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/enhance/src/xenhance_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenhance_sinit.c @addtogroup
enhance_v7_1 @{ This file contains static initialization methods for Xilinx
Enhance core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 7.0 adk 02/19/14 First release. Implemented the following function
XEnhance_LookupConfig 7.1 ms 01/31/17 Updated the parameter naming from
XPAR_ENHANCE_NUM_INSTANCES to XPAR_XENHANCE_NUM_INSTANCES to avoid compilation
failure for XPAR_ENHANCE_NUM_INSTANCES as the tools are generating
XPAR_XENHANCE_NUM_INSTANCES in the generated xenhance_g.c for fixing MISRA-C
files. This is a fix for CR-967548 based on the update in the tools. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/enhance/src/xenhance_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file example.c This file
demonstrates how to use Xilinx Gamma Correction (Gamma) driver of the Xilinx
Gamma Correction v3.0 core. This code does not cover the Gamma v3.0 setup and
any other configuration which might be required to get the Gamma device working
properly. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
3.00a jo 07/20/09 First release 3.00a gz 07/27/09 Adapted for gamma </pre> /

FILES:
XilinxProcessorIPLib/drivers/gamma/examples/example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file gamma.c @addtogroup gamma_v6_0
@{ This is main code of Xilinx Gamma Correction (GAMMA) device driver. Please
see gamma.h for more details of the driver. MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 5.01a jude 09/07/12 Updated for GAMMA V6.01.a 5.00a
tb 02/27/12 Updated for GAMMA V5.00.a 4.00a rc 09/11/11 Updated for GAMMA V4.0
3.00a jo 07/20/10 Updated for GAMMA V3.0 Include Files /

FILES:
XilinxProcessorIPLib/drivers/gamma/src/gamma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file gamma.h @addtogroup gamma_v6_0
@{ @details This header file contains identifiers and register-level driver
functions (or macros) that can be used to access the Xilinx Gamma Correction
(GAMMA) instance. MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
5.01a jude 09/07/12 Updated for GAMMA V6.01.a-Added Masks for register bits -
Converted from xio.h to xil_io.h, translating basic types, MB cache functions,
exceptions and assertions to xil_io format 5.00a tb 02/27/12 Updated for GAMMA
V5.00.a 4.00a rc 09/11/11 Updated for GAMMA V4.0 3.00a jo 07/20/10 Updated for
GAMMA V3.0 3.00a gs 07/27/10 Updated for gamma registers and functionality 6.0
adk 19/12/13 Updated as per the New Tcl API's ms 03/17/17 Added readme.txt file
in examples folder for doxygen generation.

FILES:
XilinxProcessorIPLib/drivers/gamma/src/gamma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 2.0 adk 12/10/13 Updated as per the New Tcl
API's

FILES:
XilinxProcessorIPLib/drivers/generic/data/generic.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 10/12/13 Removed support for xps_gpio
@BEGIN_CHANGELOG EDK_M 21/11/09 ktn Removed support for opb_gpio and plb_gpio
@END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3 06/16/10 sv Added support for axi_gpio
@END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/gpio/data/gpio.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_I - include header files @END_CHANGELOG
@BEGIN_CHANGELOG EDK_H - Added support for generation of multiple applications.
All TCL procedures are now required to have a software project type as its first
argument - Declared delay variable in WriteToGPOutput() function as volatile.
This causes the variable to be loaded from memory with each access and will
cause a sufficient delay when run on hardware. @END_CHANGELOG @BEGIN_CHANGELOG
EDK_H_SP1 - Generate GPIO testcode for PeripheralTest only instead of MemoryTest
because it is a peripheral, not a memory @END_CHANGELOG @BEGIN_CHANGELOG EDK_I -
Do not generate test function in TCL procedure, instead call driver example
function. @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest Global variables Each global string defined here is a C test function
definition. Each function defined here must have a unique function prototype.
Ie. ALL functions defined in this file must be capable of co-existing in the
same C file! TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/gpio/data/gpio_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_example.c This file
contains a design example using the AXI GPIO driver (XGpio) and hardware device.
It only uses channel 1 of a GPIO device and assumes that the bit 0 of the GPIO
is connected to the LED on the HW board. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a rmm 03/13/02 First release 1.00a rpm
08/04/03 Removed second example and invalid macro calls 2.00a jhl 12/15/03 Added
support for dual channels 2.00a sv 04/20/05 Minor changes to comply to Doxygen
and coding guidelines 3.00a ktn 11/20/09 Minor changes as per coding guidelines.
4.1 lks 11/18/15 Updated to use canonical xparameters and clean up of the
comments and code for CR 900381 4.3 sk 09/29/16 Modified the example to make it
work when LED_bits are configured as an output. CR 958644 ms 01/23/17 Added
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. 4.5
sne 06/12/19 Fixed IAR compiler warning. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/examples/xgpio_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_intr_tapp_example.c This
file contains a design example using the GPIO driver (XGpio) in an interrupt
driven mode of operation. This example does assume that there is an interrupt
controller in the hardware system and the GPIO device is connected to the
interrupt controller. This file is used in the Peripheral Tests Application in
SDK to include a simplified test for gpio interrupts. The buttons and LEDs are
on 2 separate channels of the GPIO so that interrupts are not caused when the
LEDs are turned on and off. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 2.01a sn 05/09/06 Modified to be used by TestAppGen to
include test for interrupts. 3.00a ktn 11/21/09 Updated to use HAL Processor
APIs and minor changes as per coding guidelines. 3.00a sdm 02/16/11 Updated to
support ARM Generic Interrupt Controller 4.1 lks 11/18/15 Updated to use
canonical xparameters and clean up of the comments and code for CR 900381 4.3 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/examples/xgpio_intr_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_low_level_example.c This
file contains a design example using the General Purpose I/O (GPIO) low level
driver and hardware device. It only uses a channel 1 of a GPIO device. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
04/29/02 First release 2.00a jhl 12/30/02 Addition of dual channel capability
2.00a sv 04/18/05 Minor changes to comply to Doxygen and coding guidelines 3.00a
ktn 11/21/09 Removed the macros XGpio_mSetDataDirection, XGpio_mGetDataReg and
XGpio_mSetDataReg. Users should use XGpio_WriteReg/XGpio_ReadReg to achieve the
same functionality. 4.1 lks 11/18/15 Updated to use canonical xparameters and
clean up of the comments and code for CR 900381 4.3 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. 4.5 sne
06/12/19 Fixed IAR compiler warning. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/examples/xgpio_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_tapp_example.c This file
contains a example for using AXI GPIO hardware and driver. This example assumes
that there is a UART Device or STDIO Device in the hardware system. @note None
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sv
04/15/05 Initial release for TestApp integration. 3.00a sv 11/21/09 Updated to
use HAL Processor APIs. 3.01a bss 04/18/13 Removed incorrect Documentation
lines.(CR 701641) 4.1 lks 11/18/15 Updated to use canonical xparameters and
clean up of the comments and code for CR 900381 4.3 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/examples/xgpio_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio.c @addtogroup gpio_v4_5
@{ The implementation of the XGpio driver's basic functionality. See xgpio.h for
more information about the driver. @note None <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a rmm 02/04/02 First release 2.00a jhl
12/16/02 Update for dual channel and interrupt support 2.01a jvb 12/13/05
Changed Initialize() into CfgInitialize(), and made CfgInitialize() take a
pointer to a config structure instead of a device id. Moved Initialize() into
xgpio_sinit.c, and had Initialize() call CfgInitialize() after it retrieved the
config structure using the device id. Removed include of xparameters.h along
with any dependencies on xparameters.h and the _g.c config table. 2.11a mta
03/21/07 Updated to new coding style, added GetDataDirection 2.12a sv 11/21/07
Updated driver to support access through DCR bus 3.00a sv 11/21/09 Updated to
use HAL Processor APIs. Renamed the macros to remove _m from the name. 4.1 lks
11/18/15 Clean up of the comments in the code and removed support for DCR bridge
4.2 sk 08/16/16 Used UINTPTR instead of u32 for Baseaddress as part of adding 64
bit support. CR 867425. Changed the prototype of XGpio_CfgInitialize API. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio.h @addtogroup gpio_v4_5
@{ @details This file contains the software API definition of the Xilinx General
Purpose I/O (XGpio) device driver. The Xilinx GPIO controller is a soft IP core
designed for Xilinx FPGAs and contains the following general features: - Support
for up to 32 I/O discretes for each channel (64 bits total). - Each of the
discretes can be configured for input or output. - Configurable support for dual
channels and interrupt generation. The driver provides interrupt management
functions. Implementation of interrupt handlers is left to the user. Refer to
the provided interrupt example in the examples directory for details. This
driver is intended to be RTOS and processor independent. Any needs for dynamic
memory management, threads or thread mutual exclusion, virtual memory, or cache
control must be satisfied by the layer above this driver. <b>Initialization &
Configuration</b> The XGpio_Config structure is used by the driver to configure
itself. This configuration structure is typically created by the tool-chain
based on HW build properties. To support multiple runtime loading and
initialization strategies employed by various operating systems, the driver
instance can be initialized in one of the following ways: -
XGpio_Initialize(InstancePtr, DeviceId) - The driver looks up its own
configuration structure created by the tool-chain based on an ID provided by the
tool-chain. - XGpio_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) - Uses a
configuration structure provided by the caller. If running in a system with
address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. @note This API utilizes
32 bit I/O to the GPIO registers. With less than 32 bits, the unused bits from
registers are read as zero and written as don't cares. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm 03/13/02 First
release 2.00a jhl 11/26/03 Added support for dual channels and interrupts 2.01a
jvb 12/14/05 I separated dependency on the static config table and xparameters.h
from the driver initialization by moving _Initialize and _LookupConfig to
_sinit.c. I also added the new _CfgInitialize routine. 2.11a mta 03/21/07
Updated to new coding style, added GetDataDirection 2.12a sv 11/21/07 Updated
driver to support access through DCR bus 2.12a sv 06/05/08 Updated driver to fix
the XGpio_InterruptDisable function to properly update the Interrupt Enable
register 2.13a sdm 08/22/08 Removed support for static interrupt handlers from
the MDD file 3.00a sv 11/21/09 Updated to use HAL Processor APIs. Renamed the
macros XGpio_mWriteReg to XGpio_WriteReg and XGpio_mReadReg to XGpio_ReadReg.
Removed the macros XGpio_mSetDataDirection, XGpio_mGetDataReg and
XGpio_mSetDataReg. Users should use XGpio_WriteReg and XGpio_ReadReg to achieve
the same functionality. 3.01a bss 04/18/13 Updated driver tcl to generate
Canonical params in xparameters.h. CR698589 4.0 adk 19/12/13 Updated as per the
New Tcl API's 4.1 lks 11/18/15 Updated to use canonical xparameters in examples
and clean up of the comments, removed support for DCR bridge and removed
xgpio_intr_example for CR 900381 4.2 sk 08/16/16 Used UINTPTR instead of u32 for
Baseaddress as part of adding 64 bit support. CR 867425. Changed the prototype
of XGpio_CfgInitialize API. 4.3 sk 09/29/16 Modified the example to make it work
when LED_bits are configured as an output. CR 958644 ms 01/23/17 Added
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. 4.4 sne 04/25/19 Updated Makefile for IAR compier
(CR-1029421). 4.5 sne 06/14/19 Fixed IAR compiler warnings on example files.
</pre>

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_extra.c @addtogroup
gpio_v4_5 @{ The implementation of the XGpio driver's advanced discrete
functions. See xgpio.h for more information about the driver. @note These APIs
can only be used if the GPIO_IO ports in the IP are used for connecting to the
external output ports. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a rmm 02/04/02 First release 2.00a jhl 12/16/02 Update for
dual channel and interrupt support 2.11a mta 03/21/07 Updated to new coding
style 3.00a sv 11/21/09 Updated to use HAL Processor APIs. Renamed the macros
XGpio_mWriteReg to XGpio_WriteReg, and XGpio_mReadReg to XGpio_ReadReg. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio_extra.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_g.c @addtogroup gpio_v4_5
@{ This file contains a configuration table that specifies the configuration of
GPIO devices in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a rmm 02/04/02 First release 2.00a jhl 12/16/02 Update
for dual channel and interrupt support 2.11a mta 03/21/07 Updated to new coding
style 4.0 sha 07/15/15 Added XPAR_XGPIO_NUM_INSTANCES macro to control config
table parameters. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_i.h @addtogroup gpio_v4_5
@{ This header file contains internal identifiers, which are those shared
between the files of the driver. It is intended for internal use only. NOTES:
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
rmm 03/13/02 First release 2.11a mta 03/21/07 Updated to new coding style </pre>

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_intr.c @addtogroup
gpio_v4_5 @{ Implements GPIO interrupt processing functions for the XGpio
driver. See xgpio.h for more information about the driver. The functions in this
file require the hardware device to be built with interrupt capabilities. The
functions will assert if called using hardware that does not have interrupt
capabilities. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 2.00a jhl 11/26/03 Initial release 2.11a mta 03/21/07 Updated to new
coding style 2.12a sv 06/05/08 Updated driver to fix the XGpio_InterruptDisable
function to properly update the Interrupt Enable register 3.00a sv 11/21/09
Updated to use HAL Processor APIs. Renamed the macros XGpio_mWriteReg to
XGpio_WriteReg, and XGpio_mReadReg to XGpio_ReadReg. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_l.h @addtogroup gpio_v4_5
@{ This header file contains identifiers and driver functions (or macros) that
can be used to access the device. The user should refer to the hardware device
specification for more details of the device operation. The macros that are
available in this file use a multiply to calculate the addresses of registers.
The user can control whether that multiply is done at run time or at compile
time. A constant passed as the channel parameter will cause the multiply to be
done at compile time. A variable passed as the channel parameter will cause it
to occur at run time. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a jhl 04/24/02 First release of low level driver 2.00a jhl
11/26/03 Added support for dual channels and interrupts. This change required
the functions to be changed such that the interface is not compatible with
previous versions. See the examples in the example directory for macros to help
compile an application that was designed for previous versions of the driver.
The interrupt registers are accessible using the ReadReg and WriteReg macros and
a channel parameter was added to the other macros. 2.11a mta 03/21/07 Updated to
new coding style 2.12a sv 11/21/07 Updated driver to support access through DCR
bus. 3.00a sv 11/21/09 Renamed the macros XGpio_mWriteReg to XGpio_WriteReg
XGpio_mReadReg to XGpio_ReadReg. Removed the macros XGpio_mSetDataDirection,
XGpio_mGetDataReg and XGpio_mSetDataReg. Users should use
XGpio_WriteReg/XGpio_ReadReg to achieve the same functionality. 4.1 lks 11/18/15
Removed support for DCR bridge </pre>

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_selftest.c @addtogroup
gpio_v4_5 @{ The implementation of the XGpio driver's self test function. See
xgpio.h for more information about the driver. @note None <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm 02/04/02 First
release 2.00a jhl 01/13/04 Addition of dual channels and interrupts. 2.11a mta
03/21/07 Updated to new coding style 3.00a sv 11/21/09 Updated to use HAL
Processor APIs. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpio_sinit.c @addtogroup
gpio_v4_5 @{ The implementation of the XGpio driver's static initialization
functionality. @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 2.01a jvb 10/13/05 First release 2.11a mta 03/21/07 Updated to new
coding style 4.0 sha 07/15/15 Defined macro XPAR_XGPIO_NUM_INSTANCES if not
defined in xparameters.h </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpio/src/xgpio_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_intr_example.c This
file contains a design example using the GPIO driver (XGpioPs) in an interrupt
driven mode of operation. The example uses the interrupt capability of the GPIO
to detect push button events and set the output LEDs based on the input. @note
This example assumes that there is a Uart device in the HW design. This example
is to provide support only for zcu102 on ZynqMp Platform and only for zc702 on
Zynq Platform. For ZynqMP Platform, Input pin is 22(sw19 on zcu102 board) and
Output Pin is 23(DS50 on zcu102 board). For Zynq Platform, Input Pins are
12(sw14 on zc702 board), 14(sw13 on zc702 board) and Output Pin is 10(DS23 on
zc702 board). SW15 on zc702 board is a combination of sw13 and sw14. To operate
either of the input pins, keep SW15 low(both should be 00). <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sv 01/18/10 First
Release 3.3 ms 04/17/17 Added notes about gpio input and output pin description
for zcu102 and zc702 boards, configured Interrupt pin to input pin for proper
working of interrupt example. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/examples/xgpiops_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_polled_example.c This
file contains an example for using GPIO hardware and driver. This example
provides the usage of APIs for reading/writing to the individual pins. Please
see xgpiops.h file for description of the pin numbering. @note This example
assumes that there is a Uart device in the HW design. This example is to provide
support only for zcu102 on ZynqMp Platform and only for zc702 on Zynq Platform.
For ZynqMP Platform, Input pin is 22(sw19 on zcu102 board) and Output Pin is
23(DS50 on zcu102 board). For Zynq Platform, Input Pins are 12(sw14 on zc702
board), 14(sw13 on zc702 board) and Output Pin is 10(DS23 on zc702 board). In
versal Platform we have two devices(PMC GPIO and PS GPIO),PMC contain 4 banks
and 116 pins,PS GPIO contain 2 banks and 58 pins. This example can work for both
PS and PMC GPIO based on the value of GPIO_DEVICE_ID The default value of 0
makes this example work for PMC GPIO controller. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a sv 01/18/10 First Release 1.01a sv
04/15/12 Removed the calling of some unnecessary APIs. Updated the examples for
a ZC702 board . Updated the example to use only pin APIs. 3.3 ms 04/17/17 Added
notes about input and output pin description for zcu102 and zc702 boards. 3.5
sne 04/26/19 Added versal support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/examples/xgpiops_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops.c @addtogroup
gpiops_v3_7 @{ The XGpioPs driver. Functions in this file are the minimum
required functions for this driver. See xgpiops.h for a detailed description of
the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sv 01/15/10 First Release 1.01a sv 04/15/12 Removed the APIs
XGpioPs_SetMode, XGpioPs_SetModePin XGpioPs_GetMode, XGpioPs_GetModePin as they
are not relevant to Zynq device. The interrupts are disabled for output pins on
all banks during initialization. 2.1 hk 04/29/14 Use Input data register DATA_RO
for read. CR 771667. 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. 3.1 kvn 04/13/15 Add support for Zynq Ultrascale+ MP. CR 856980. 3.1
aru 07/13/18 Resolved doxygen reported warnings. CR 1006331. 3.4 aru 08/17/18
Resolved MISRA-C mandatory violations. CR 1007751 3.5 sne 03/01/19 Fixes
violations according to MISRAC-2012 in safety mode and modified the code such as
Use of mixed mode arithmetic,Declared the pointer param as Pointer to
const,Casting operation to a pointer, Literal value requires a U suffix. 3.5 sne
03/13/19 Added Versal support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops.h @addtogroup
gpiops_v3_7 @{ @details The Xilinx PS GPIO driver. This driver supports the
Xilinx PS GPIO Controller. The GPIO Controller supports the following features:
- 4 banks - Masked writes (There are no masked reads) - Bypass mode -
Configurable Interrupts (Level/Edge) This driver is intended to be RTOS and
processor independent. Any needs for dynamic memory management, threads or
thread mutual exclusion, virtual memory, or cache control must be satisfied by
the layer above this driver. This driver supports all the features listed above,
if applicable. <b>Driver Description</b> The device driver enables higher layer
software (e.g., an application) to communicate to the GPIO. <b>Interrupts</b>
The driver provides interrupt management functions and an interrupt handler.
Users of this driver need to provide callback functions. An interrupt handler
example is available with the driver. <b>Threads</b> This driver is not thread
safe. Any needs for threads or thread mutual exclusion must be satisfied by the
layer above this driver. <b>Asserts</b> Asserts are used within all Xilinx
drivers to enforce constraints on argument values. Asserts can be turned off on
a system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b>Building the driver</b> The XGpioPs driver is composed of
several source files. This allows the user to build and link only those parts of
the driver that are necessary. <br><br> <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a sv 01/15/10 First Release 1.01a sv 04/15/12
Removed the APIs XGpioPs_SetMode, XGpioPs_SetModePin XGpioPs_GetMode,
XGpioPs_GetModePin as they are not relevant to Zynq device.The interrupts are
disabled for output pins on all banks during initialization. 1.02a hk 08/22/13
Added low level reset API 2.1 hk 04/29/14 Use Input data register DATA_RO for
read. CR 771667. 2.2 sk 10/13/14 Used Pin number in Bank instead of pin number
passed to APIs. CR 822636 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. 3.1 kvn 04/13/15 Add support for Zynq Ultrascale+ MP. CR 856980. ms
03/17/17 Added readme.txt file in examples folder for doxygen generation. ms
04/05/17 Added tabspace for return statements in functions of gpiops examples
for proper documentation while generating doxygen. 3.3 ms 04/17/17 Added notes
about gpio input and output pin description for zcu102 and zc702 boards in
polled and interrupt example, configured Interrupt pin to input pin for proper
functioning of interrupt example. 3.4 aru 08/17/18 Resolved MISRA-C mandatory
violations. CR 1007751 3.5 sne 03/01/19 Fixes violations according to
MISRAC-2012 in safety mode and modified the code such as Use of mixed mode
arithmetic,Declared the pointer param as Pointer to const,Casting operation to a
pointer, Literal value requires a U suffix. 3.5 sne 03/14/19 Added Versal
support. 3.6 mus 04/05/19 Replaced XPLAT_versal macro with XPLAT_VERSAL, to be
in sync with standalone BSP 3.7 sne 06/12/19 Fixed IAR compiler warning. </pre>

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_g.c @addtogroup
gpiops_v3_7 @{ This file contains a configuration table that specifies the
configuration of GPIO devices in the system. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a sv 01/15/10 First Release 3.00 kvn
02/13/15 Modified code for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_hw.c @addtogroup
gpiops_v3_7 @{ This file contains low level GPIO functions. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.02a hk 08/22/13 First
Release 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.1 kvn
04/13/15 Add support for Zynq Ultrascale+ MP. CR 856980. 3.5 sne 03/01/19 Fixes
violations according to MISRAC-2012 in safety mode and modified the code such as
Use of mixed mode arithmetic,Declared the pointer param as Pointer to
const,Casting operation to a pointer, Literal value requires a U suffix. 3.5 sne
03/14/19 Added versal support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_hw.h @addtogroup
gpiops_v3_7 @{ This header file contains the identifiers and basic driver
functions (or macros) that can be used to access the device. Other driver
functions are defined in xgpiops.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a sv 01/15/10 First Release 1.02a hk 08/22/13
Added low level reset API function prototype and related constant definitions
3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.1 kvn 04/13/15
Corrected reset values of banks. 3.5 sne 03/14/19 Added versal support. </pre>

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_intr.c @addtogroup
gpiops_v3_7 @{ This file contains functions related to GPIO interrupt handling.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sv
01/18/10 First Release 2.2 sk 10/13/14 Used Pin number in Bank instead of pin
number passed to API's. CR 822636 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. 3.1 kvn 04/13/15 Add support for Zynq Ultrascale+ MP.
CR 856980. 3.1 aru 07/13/18 Ressolved doxygen reported warnings. CR 1006331. 3.4
aru 08/09/18 Ressolved cppcheck warnings. 3.4 aru 08/17/18 Resolved MISRA-C
mandatory violations. CR 1007751 3.5 sne 03/01/19 Fixes violations according to
MISRAC-2012 in safety mode and modified the code such as Use of mixed mode
arithmetic,Declared the pointer param as Pointer to const,Casting operation to a
pointer, Literal value requires a U suffix. 3.5 sne 03/14/19 Added Versal
support. 3.5 sne 03/20/19 Fixed multiple interrupts problem CR1024556. 3.7 sne
06/12/19 Fixed IAR compiler warning. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_selftest.c @addtogroup
gpiops_v3_7 @{ This file contains a diagnostic self-test function for the
XGpioPs driver. Read xgpiops.h file for more information. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sv 01/18/10 First
Release 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.5 sne
03/01/19 Fixes violations according to MISRAC-2012 in safety mode and modified
the code such as Use of mixed mode arithmetic,Declared the pointer param as
Pointer to const,Casting operation to a pointer, Literal value requires a U
suffix. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xgpiops_sinit.c @addtogroup
gpiops_v3_7 @{ This file contains the implementation of the XGpioPs driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a sv 01/15/10 First Release 3.00 kvn
02/13/15 Modified code for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/gpiops/src/xgpiops_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x.c @addtogroup
hdcp1x_v4_2 @{ This contains the implementation of the HDCP state machine module
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
fidus 07/16/15 Initial release. 2.00 als 09/30/15 Added EffectiveAddr argument
to XHdcp1x_CfgInitialize. 2.10 MG 01/18/16 Added function XHdcp1x_IsEnabled.
2.20 MG 01/20/16 Added function XHdcp1x_GetHdcpCallback. 2.30 MG 02/25/16 Added
function XHdcp1x_SetCallback and authenticated callback. 3.0 yas 02/13/16
Upgraded to support HDCP Repeater functionality. Added functions:
XHdcp1x_DownstreamReady, XHdcp1x_GetRepeaterInfo, XHdcp1x_SetCallBack,
XHdcp1x_ReadDownstream 4.0 yas 07/30/16 Addded function: XHdcp1x_SetRepeater,
XHdcp1x_IsInComputations, XHdcp1x_IsInWaitforready, XHdcp1x_IsDwnstrmCapable,
XHdcp1x_GetTopology, XHdcp1x_DisableBlank, XHdcp1x_EnableBlank,
XHdcp1x_GetTopologyKSVList, XHdcp1x_GetTopologyBKSV, XHdcp1x_SetTopologyField,
Hdcp1x_GetTopologyField, XHdcp1x_IsRepeater, XHdcp1x_SetTopology,
XHdcp1x_SetTopologyKSVList, XHdcp1x_SetTopologyUpdate. 4.0 yas 08/16/16 Used
UINTPTR instead of u32 for BaseAddress XHdcp1x_CfgInitialize 4.1 yas 11/10/16
Added function XHdcp1x_SetHdmiMode. 4.1 yas 08/03/17 Updated the initialization
to memset the XHdcp1x structure to 0. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x.h @addtogroup
hdcp1x_v4_2 @{ @details This is the Xilinx HDCP device drivers. The Xilinx HDCP
driver software is provided to allow for the integration of HDCP functionality
into designs that make use of the DisplayPort and HDMI LogiCORE IP video
interface cores. This software is distributed within the Xilinx SDK (Software
Development Kit) and is tightly coupled with the SDK drivers for these
interfaces. This appendix serves as a technical reference describing the
architecture and functionality of HDCP driver software as well as providing
guidelines for integrating it into a custom DisplayPort and/or HDMI system
designs based on Xilinx programmable devices. <b> Platform Requirements </b> The
current platform requirements for the HDCP driver software are as follows: - One
or more of the following video interfaces (subject to any and all identified
Restrictions and Limitations): - DisplayPort receive - DisplayPort transmit -
HDMI receive - HDMI transmit - One HDCP 1.x cipher LogiCORE IP instance per
video interface that supports HDCP 1.x. - One HDCP device key set per video
interface that supports HDCP 1.x and the associated RTL/IP to interface these to
the HDCP 1.x ciphers. - One timer resource per HDCP 1.x transmit interface that
can support durations from a few milliseconds up to several seconds in length. -
Approximately 128 KB of free code space (HDCP specifics only) - Approximately 1
KB of free data space per HDCP interface (HDCP specifics only). <b> Restrictions
and Limitations </b> The HDCP driver software has the following restrictions and
limitations: - DisplayPort receiver and HDMI receiver interfaces are not
supported within the same platform design. - DisplayPort transmitter and HDMI
transmitter interfaces are not supported within the same platform design. -- --
-- -- -- -- -- -- -- -- -- -- <b> HDCP Driver Architecture </b> The architecture
of the HDCP software driver can be divided into three distinct submodules. -
Cipher device - Port device - Authentication state machine(s) Each of these
modules represents a specific function and/or entity within the driver and work
in unison to implement the HDCP software support within the system design. The
design of the driver encapsulates all of these submodules into a unified API
that is used by the client software application with a single instance of an
HDCP interface. <b> Cipher Device </b> The cipher device is contained within the
HDCP driver software and represents an instance of the HDCP cipher LogiCORE IP
block within a system design. Given that the variants of this cipher core
provide the same interface to the software, a single implementation of this
submodule is used to drive all of them. In the few places where behaviors differ
slightly between variants, this software adjusts at runtime based on the
contents of a Type/ID register within the IP core. The principal function of the
cipher device submodule is to initialize, configure, and monitor the physical
encryption cipher used within the HDCP application. As part of this, it provides
an interface that allows the software to trigger the reading of the appropriate
device key set from the custom key management solution that is attached to the
cipher core. The cipher device submodule is used by higher-level authentication
state machines to run re-authentication requests, generate pseudo-random
numbers, and enable/disable encryption on individual video streams passing
through the cipher core. It also provides a status output from the actual
encryption process that can be used by the authentication state machines to
monitor the correct operation of the HDCP function. The interrupts generated by
the cipher core are fully consumed within the HDCP software driver; the client
software application needs only to register the cipher core interrupt with the
associated vector within the appropriate interrupt controller of the system
design. These interrupts are forwarded to the cipher submodule through an
appropriate external API of the software driver (XHdcp1x_CipherIntrHandler). The
software driver source files that are associated with this submodule are as
follows: - xhdcp1x_cipher.c - xhdcp1x_cipher.h - xhdcp1x_cipher_intr.c -
xhdcp1x_hw.h <b> Port Device </b> The port device(s) that exists within the HDCP
software driver represent the management and access to the HDCP register sets
that are defined within the HDCP specifications. While the register sets are
similar between HDMI and DisplayPort, they do differ, and as a result there are
slightly different implementations of these port devices between the two.
Regardless of the physical interface type, the transmit port device is always
the master of the register set transactions and the receive port device is
always the slave. For transmit port devices, they provide the ability to read
and write the HDCP register set that exists on their attached receive (slave)
device. These transactions are always run to completion and are initiated solely
by the corresponding transmit state machine and/or as part of a debug process if
explicitly requested. For receive port devices, they only provide access to the
local HDCP register set; they cannot be used to read the register set from the
attached transmit device. Local reads and writes of this register set are
performed by the appropriate receive state machine (or debug process) and remote
reads and writes can be performed by the transmit port (master) device. Remote
access (either read or write) to a subset of the register set generates
notifications (for example, interrupts) to the device that are then in turn
posted to the corresponding receive state machine for driving authentication and
related procedures. The underlying implementation of the supported HDCP port
device modules is completely dependent on the Xilinx BSP device driver for the
corresponding video interface type. As a result, the client application software
is required to provide the device handle of the video interface that the
specific HDCP driver instance is bound to during initialization of the HDCP
software driver. For more information on the BSP Standalone driver, see the
following documents: - Xilinx Software Developer Kit Help (UG782) - OS and
Libraries Document Collection (UG643) The internals of the port device rely on
the use of an adapter structure (a jump table) which maps the HDCP port device
API into a protocol (DisplayPort/HDMI) and direction (RX/TX) specific function
that implements the associated functionality. This adapter structure
(XHdcp1x_PortPhyIfAdaptor) allows for the correct function to be determined and
called at run-time based on the exact type of the HDCP interface in question. In
some instances (specifically DisplayPort TX), there is no specific port device
interrupt defined and, as such, the relevant interrupt(s) (HPD) must be
forwarded to the port device submodule through an appropriate external API of
the software driver (XHdcp1x_PortIntrHandler). The software driver source files
that are associated with this submodule are as follows: - xhdcp1x_port.c -
xhdcp1x_port.h - xhdcp1x_port_dp.h - xhdcp1x_port_dp_rx.c - xhdcp1x_port_dp_tx.c
- xhdcp1x_port_hdmi.h - xhdcp1x_port_hdmi_rx.c - xhdcp1x_port_hdmi_tx.c -
xhdcp1x_port_intr.c <b> Authentication State Machines </b> The transmit and
receive authentication state machines contained within the driver software
mirror those that are defined within the appropriate HDCP specifications. To
facilitate integration and debugging, the names of the individual states are
aligned with those defined within the specifications wherever possible. The
state machines are responsible for driving the authentication, encryption, and
link monitoring processes as requested by the client application software. The
state machines co-ordinate the operation of the cipher, port device(s), and the
physical video interface (HDMI or DisplayPort), and rely upon the proper
programming and availability of HDCP device keys. The state machines make use of
a simple, OS-independent scheduler to allow for messages and requests to be
posted to and from them. This requires the client application software to
regularly call a poll function on each HDCP interface to ensure the timely
servicing of these messages/requests. The transmit state machine provides
interfaces that allow for the client application software to request
authentication, enable/disable the encryption of video streams, and monitor the
progress/outcome of authentication and the ongoing integrity of the encrypted
video data. The transmit state must be notified of changes in the physical state
of the interface it is running over (either HDMI or DisplayPort) to ensure that
any required re-authentication is performed without explicit intervention of the
client software application. It fully supports downstream HDCP receivers and
repeaters. For a detailed diagram of this state machine, see either figure 2-6
in the High-bandwidth Digital Content Protection System v1.3 Amendment for
DisplayPort specification or figure 2-9 in the High-bandwidth Digital Content
Protection System v1.4 specification. The transmit state definitions are
contained within the XHdcp1x_StateType contained within the xhdcp1x_tx.c source
file. The receive state machine is much simpler than the transmit in that it is
not entirely aware of the success/failure of the authentication process. It
merely initiates the calculations required for authentication and makes the
result available within its HDCP register set for examination by the
transmitter. It allows for the client application software to explicitly
enable/disable the HDCP capability of the underlying video interface and to
query whether encrypted video is being received at any point in time. It also
requires that it be notified of changes in the physical interface it is running
over so that the appropriate side effects can be initiated. For a detailed
diagram of this state machine, see either figure 2-7 in the the High-bandwidth
Digital Content Protection System v1.3 Amendment for DisplayPort specification
or figure 2-10 in the High-bandwidth Digital Content Protection System v1.4
specification. The receive state definitions are contained within the
XHdcp1x_StateType contained within the xhdcp1x_rx.c source file. Both the
transmit and receive state machines make use of a link verification procedure to
ensure that both ends of the encrypted link remain synchronized over time. This
mechanism differs between DisplayPort and HDMI and is detailed in section 2.2.4
of the High-bandwidth Digital Content Protection System v1.3 Amendment for
DisplayPort specification [Ref 1] and section 2.2.3 of the High-bandwidth
Digital Content Protection System v1.4 specification respectively. The software
driver source files that are associated with this submodule are as follows: -
xhdcp1x.c - xhdcp1x.h - xhdcp1x_intr.c - xhdcp1x_platform.c - xhdcp1x_platform.h
- xhdcp1x_rx.c - xhdcp1x_rx.h - xhdcp1x_selftest.c - xhdcp1x_sinit.c -
xhdcp1x_tx.c - xhdcp1x_tx.h <b> Device Key Management </b> The device key
management software and RTL/IP implementation interact with the HDCP software
driver but are, in the strictest sense, outside of the scope of this driver. The
Xilinx HDCP solution is designed such that each individual platform integrator
is responsible for the security and storage of the HDCP device keys that are
issued to them by DCP LLC. The physical interface between the LogiCORE IP HDCP
Cipher Product Guide and the custom implemented key storage is described in the
High-bandwidth Digital Content Protection System v1.3 Amendment for DisplayPort
specification and the High-bandwidth Digital Content Protection System v1.4
specification. <b> Dependencies </b> The only dependencies between the HDCP
driver software and the actual device key management implementation are, as
follows: - The device keys must be available to be loaded into the HDCP cipher
LogiCORE IP prior to initializing the corresponding instance of the HDCP
software driver. - The HDCP software driver supports the programming of key set
selection vector. This can be used in applications where multiple sets of device
keys are available for use. This vector allows for one of up to eight different
device key sets to be selected as the data to be loaded when requested by the
cipher core. The API function used to set this selection vector is
XHdcp1x_SetKeySelect. -- -- -- -- -- -- -- -- -- -- -- -- <b> HDCP Driver
Porting Guide </b> The following system resources are required by the HDCP
software driver software: - Approximately 128 KB of free code space -
Approximately 1 KB of free data space per HDCP driver instance - Approximately 1
KB of stack space - One dedicated operating system thread/task for HDCP (if an
operating system is being used) Note: These resource requirements are those
needed explicitly for HDCP. The requirements associated with the mandatory video
interface(s), HDMI or DisplayPort (DP) are not included. <b> Integrating Into
Your Application </b> The HDCP software driver can be integrated into any client
software application, regardless of whether an operating system is used or not.
This integration generally consists of a few simple steps. 1. Allocation of the
required number of HDCP driver instances. 2. Binding of the system timer
interface functions (only needed if HDCP transmit interfaces are to be used).
These functions are used by the state machines to run guard timers where
appropriate within the authentication procedure. These functions are, as
follows: - XHdcp1x_SetTimerStart - XHdcp1x_SetTimerStop - XHdcp1x_SetTimerDelay
3. Binding of the platform-specific timer expiry handling to call
XHdcp1x_HandleTimeout when a timer started using the interfaces in step 2
expires. 4. Optional binding of the platform specific function that tests KSV
against a stored revocation list (HDCP transmit interfaces only) using
XHdcp1x_SetKsvRevokeCheck. 5. Initialization, self-test, and basic configuration
of the HDCP driver instances. The relevant functions are: -
XHdcp1x_CfgInitialize - XHdcp1x_LookupConfig - XHdcp1x_SelfTest -
XHdcp1x_SetKeySelect 6. Binding of the HDCP cipher core interrupt lines and
callback functions with the platform interrupt controller(s). The relevant
function is XHdcp1x_CipherIntrHandler. 7. Registration of the HDCP 1.x port
interrupt handler with the corresponding HDMI or DisplayPort device driver. The
relevant function is XHdcp1x_PortIntrHandler. - DisplayPort RX: not used -
DisplayPort TX: insert into the HPD event and interrupt callback functions -
HDMI RX/TX: not used 8. Insertion of calls to HDCP set physical state and lane
count function(s) in the appropriate physical interface driver callback
functions (HDMI or DisplayPort). The functions of interest are: -
XHdcp1x_SetPhysicalState - DisplayPort RX: insert into the driver callbacks that
handle training done (up), training lost (down), bandwidth change (down), and
cable unplug (down) - DisplayPort TX: insert in the function that starts/trains
the DisplayPort link (up or down based on the outcome) - HDMI RX/TX: call in the
stream up/down callback functions - XHdcp1x_SetLaneCount - DisplayPort RX:
insert into the training done driver callback - DisplayPort TX: insert in the
function that starts/trains the DisplayPort link - HDMI RX/TX: not used 9.
Insertion of a call to poll each of the HDCP driver instances within either the
main loop of the client software application (bare-metal) or within an HDCP
specific thread (operating system). The relevant function within the driver
software is XHdcp1x_Poll. 10. Insertion of calls where appropriate within the
client specific application software to administratively manage and monitor the
operation of the HDCP driver instances. - XHdcp1x_Authenticate (transmit
interfaces only) - XHdcp1x_Disable - XHdcp1x_DisableEncryption (transmit
interfaces only) - XHdcp1x_Enable - XHdcp1x_EnableEncryption (transmit
interfaces only) - XHdcp1x_GetEncryption - XHdcp1x_IsAuthenticated -
XHdcp1x_IsInProgress It is important to note that the physical video interfaces
over which HDCP is to be run must physically exist and be initialized prior to
the initialization of the corresponding HDCP driver instance. If this is not the
case, then the HDCP driver software will not work as designed. In addition,
interrupts on the physical interface should not be enabled until after the
corresponding HDCP driver instance has been initialized. While the successful
operation of this driver relies on the use interrupts, there are no external
interrupt callbacks to be registered specifically by the client software using
the HDCP software driver. All of the HDCP-specific interrupts are fully consumed
within the software driver and all the client software needs to do is properly
complete integration using step 6, step 7, and step 8. IMPORTANT: Virtually all
of the exported API functions that do not query the state of the driver require
a subsequent call to the poll function in order for the request to be fully
serviced by the indicated driver instance. As a result, it is crucial that the
interface be polled in a timely fashion subsequent to such an API call. <b>
Debugging </b> The HDCP software driver software provides two different
mechanisms for facilitating the integration and debug into client application
software. These are: - Runtime debug logging information - On demand detailed
status display To enable the runtime debug logging of the driver software, the
client application can register a printf-style debug logging function with the
driver using the appropriate API. If this is done, then the authentication state
machines log all state transitions and periodic status information, providing
significant insight into their operation. The function that can be used to
register this logging function is XHdcp1x_SetDebugLogMsg. Note: This debug
logging is enabled/disabled on the driver as a whole (as opposed to on a single
interface at a time) and does not support priorities of any kind. In addition to
runtime logging, the client application can register a printf-style debug print
function with the driver software. This registration permits the driver to
perform a one-time dump of detailed status information related to a specific
HDCP driver instance when triggered by the client application software. The
relevant functions for this are: - XHdcp1x_SetDebugPrintf - XHdcp1x_Info The
information displayed using the XHdcp1x_Info function includes details on the
current/previous state, encryption status, driver/core version(s), as well as
statistics detailing the operation of the authentication state machine (RX and
TX) and as its corresponding cipher and port sub-modules. The format of the
information displayed differs slightly based on whether the HDCP interface is in
the receive or transmit direction -- -- -- -- -- -- -- -- -- -- -- -- <b>
Receive Authentication </b> The CE register accesses associated with the
receiver authentication should be as follows: - Write of the Control register to
enable the core, enable immediate register updates and set the number of lanes
to be used. - Write the Cipher Control register to set Bit[0] (the XOR function
is to be enabled on the receiver for authentication). - Write of the Key
Management Block Control register to load local KSV. Set and then immediately
clear Bit[0]. - Read of Key Management Block Status register and check Bit[0] to
confirm local KSV available (poll as required). - Read of the Local KSV (H) and
Local KSV (L) registers. - Write of the Remote KSV (H) and Remote KSV (L)
registers with the KSV value sent by the TX. - Write of the Key Management Block
Control register to trigger the calculation of Km. Set and then immediately
clear Bit[1]. Set Key Management Block control register to abort Km calculation,
and then immediately clear Bit[2]. - Read of the Key Management Status register
and check Bit[1] to confirm Km available (poll as required). - Write of Cipher
Bx, By, and Bz registers (with An). - Read the calculated value of Km and write
of Cipher Kx, Ky, and Kz registers (with Km) if needed by the Cipher version. -
Write to Cipher Control register to initiate block cipher. Clear Bit[16] to
ensure that the calculated Km value is used. Set and then immediately clear
Bit[8]. - Read of Cipher Status register and check Bit[8] to confirm block
cipher complete (poll as required). - Read of Cipher Ri register. Note: Any step
that requires the writing of multiple registers are "book ended" with the
clearing and subsequent setting of the register update bit within the Control
register. -- -- -- -- -- -- -- -- -- -- -- -- <b> Transmit Authentication </b>
The CE register accesses associated with the transmitter authentication should
be as follows: - Write of the Control register to enable the core, enable
immediate register updates and set the number of lanes to be used. - Write the
Cipher Control register to clear Bit[0] (the XOR function is to be disabled on
the transmitter for authentication). - Write of the Cipher Control register to
generate random number. Bit[10] should be set and immediately cleared. - Read of
Cipher Status register and check Bit[10] to confirm RNG complete (poll as
required). - Read of the Cipher Mi (H) and Cipher Mi (L) registers (this value
is An). - Write of the Key Management Control register to load local KSV. Set
and then immediately clear Bit[0]. - Read of Key Management Status register and
check Bit[0] to confirm local KSV available (poll as required). - Read of the
Local KSV (H) and Local KSV (L) registers. - Write of the Remote KSV (H) and
Remote KSV (L) registers with the value read from the RX. - Write of the Key
Management Control register to calculate Km. Set and immediately clear Bit[1].
Set Key Management Block control register to abort Km calculation, and then
immediately clear Bit[2] - Read of the Key Management Status register and check
Bit[1] to confirm Km available (poll as required). - Write of Cipher Bx, By, and
Bz registers (with An + repeater bit). - Read the calculated value of Km and
write of Cipher Kx, Ky, and Kz registers (with Km) if needed by the Cipher
version. - Write to Cipher Control register to initiate block Cipher. Clear
Bit[16] to ensure that the calculated Km value is used. Set and then immediately
clear Bit[8]. - Read of Cipher Status register and check Bit[8] to confirm block
cipher complete (poll as required). - Read of Cipher Ri register. Note: Any step
that requires the writing of multiple registers are "book ended" with the
clearing and subsequent setting of the register update bit within the Control
register. -- -- -- -- -- -- -- -- -- -- -- -- <b> HDCP REPEATER </b> The HDCP
Repeater functionality is implemented in the drivers. Here however, the user has
to ensure that the right setup is available for the HDCP repeater drivers. - The
use must also ensure that the variable IsRepeater in the instance of the
structure XHdcp1x defined in the user application is set to 1. For example,
DpRxSsInst.Hdcp1x->IsRepeater 1. <b> Requirements </b> - The system has both the
receiver and the transmitter interface. - The IsRepeater variable of the hdcp
core structure, XHdcp1x is set. - The callbacks for Repeater are set in the user
application. <b> Repeater State Machine for Transmitter </b> For the transmitter
system, the repeater state machine has the following states: - STATE_DISABLED -
STATE_UNAUTHENTICATED - STATE_COMPUTATIONS - STATE_WAITFORDOWNSTREAM (in
repeater only) - STATE_ASSEMBLEKSVLIST (in repeater only) - STATE_AUTHENTICATED
- STATE_LINKINTEGRITYFAILED - STATE_PHYDOWN For the receiver system, the
repeater state machine has the following states: - STATE_DISABLED -
STATE_DETERMINERXCAPABLE - STATE_EXCHANGEKSVS - STATE_COMPUTATIONS -
STATE_VALIDATERX - STATE_AUTHENTICATED - STATE_LINKINTEGRITYCHECK -
STATE_TESTFORREPEATER - STATE_WAITFORREADY (in repeater only) -
STATE_READKSVLIST (in repeater only) - STATE_UNAUTHENTICATED - STATE_PHYDOWN <b>
Repeater Flow </b> <pre> |> Receiver <| |> User App <| |> Transmitter <| -> AKSV
Written to Receiver | Ro' written to upstream | -- Trigger Downstream
(Hdcp1x.Rx.Repeater DownstreamAuthCallBack) -- Transmitter writes AKSV and An
downstream | Transmitter reads back Ro' and completes first part of
authentication | -----(No)---- Is Downstream Repeater? | | (Yes) | Read the
downstream KSV | FIFO, calculate the SHA-1 | value and complete 2nd part | of
authentication. | ---------- Setup the KSV FIFO for upstream. | Exchange
Repeater < Values (Hdcp1x.Tx. ExchangeRepeaterCallBack) Here Get the KSV FIFO
and update it for the Receiver. | Assemble the < KSV List and calculate the
SHA-1 value and write it to upstream. | Goto Authenticated state. </pre> The
Repeater authentication requires the presence of both RX and TX interfaces. The
authentication begins when the upstream transmitter writes the An and AKSV to
the RX interface. After completing the first part of authentication the Receiver
calls the DownstremaAuthCallBack callback handler. This handler should be set in
the user application and should post the authenticate event to the TX state
machine. This will trigger the TX authentication process. The TX completes the
first part of authentication, by writing the AKSV and An downstreama and then
reading an comparing the downstream Ro' value. If the downstream device is also
Repeater, then the TX waits for the READY bit to get set in the downstream and
reads the KSV FIFO. The TX then commences the second part of the authentication,
where it calculates the SHA-1 value V and compares it with the V' read from the
downstream. If the SHA-1 value V matches with the V' value read from downstream,
authentication is successful. Here the TX sets up a RepeaterExchange value which
it populates with the KSV FIFO of the downstream and the depth and device count
values read from downstream. At this point the KSV FIFO calls the
ExchangeRepeaterCallBack, which needs to be set in the user application. Here
the user application receives the KSV FIFO value, depth and device count from
the TX of the downstream topology. The user applicaition needs to update these
value and set them for the receiver. At this point the RX is expected to be in
the WAIT-FOR-READY state. Here the user should post EVENT_DOWNSTREAMREADY to the
RX state machine. Consequently, the RX state machine will calculate the SHA-1
value, update the device count and depth value and set the READY bit for the
upstream transmitter device to read and complete the authentication. If the
authentication fails and the upstream device triggers the authentication again,
then the entire authenitcation process is re-started. <b> HDCP (Repeater)
Callback functions </b> - Transmitter - XHdcp1xInst.Tx.RepeaterExchangeCallback
(Repeater) - XHdcp1xInst.Tx.UnauthenticatedCallback - Receiver -
XHdcp1xInst.Rx.RepeaterDownstreamAuthCallback (Repeater) -
XHdcp1xInst.Rx.AuthenticatedCallback - XHdcp1xInst.Rx.UnauthenticatedCallback -
XHdcp1xInst.Rx.TopologyUpdateCallback - XHdcp1xInst.Rx.EncryptionUpdateCallback
Handler associated with each callback: - XHdcp1xInst.Tx.RepeaterExchangeCallback
- XHDCP1X_HANDLER_RPTR_RPTREXCHANGE - RepeaterExchangeCallback has to be defined
by the user, in order to set get the KSV values from the downstream transmitter
and set the values in the Receiver's Ksv List. This function is called by the
drivers. - XHdcp1xInst.Tx.UnauthenticatedCallback -
XHDCP1X_HANDLER_UNAUTHENTICATED - UnauthenticatedCallback has to be defined by
the user , to handle repeater situations where the transmitter state machine
goes to the unauthenticate state. -
XHdcp1xInst.Rx.RepeaterDownstreamAuthCallback -
XHDCP1X_HANDLER_RPTR_TRIGDWNSTRMAUTH - RepeaterDownstreamAuthCallback has to be
defined by the user in order to ensure that the downstream is ready to begin
afer 1st part of authentication is completed on the RX side. The user must
ensure that TX is not in physical-layer-down state and consequently post the
EVENT_AUTHENTICATE to the TX interface in order to begin the authentication
process for the downstream TX interface. Called by the drivers. -
XHdcp1xInst.Rx.AuthenticatedCallback - XHDCP1X_HANDLER_AUTHENTICATED -
AuthenticatedCallback has to be defined by the user and is called when the HDCP
state machine has completed authentication. -
XHdcp1xInst.Rx.UnauthenticatedCallback - XHDCP1X_HANDLER_UNAUTHENTICATED -
UnauthenticatedCallback has to be defined by the user , to handle repeater
situations where the transmitter state machine goes to the unauthenticate state.
- XHdcp1xInst.Rx.TopologyUpdateCallback - XHDCP1X_HANDLER_TOPOLOGY_UPDATE - The
TopologyUpdateCallback should be set by the user to handle changes in downstream
topology. This is currently not supprted for hdcp 1.4. -
XHdcp1xInst.Rx.EncryptionUpdateCallback - XHDCP1X_HANDLER_ENCRYPTION_UPDATE -
The EncryptionUpdateCallback needs to be set by the user and is called if the
upstream device stops sending encrypted content to the receiver after
authentication or vice-versa. -- -- -- -- -- -- -- -- -- -- -- -- <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 fidus
07/16/15 Initial release. 2.00 als 09/30/15 Added EffectiveAddr argument to
XHdcp1x_CfgInitialize. 2.10 MG 01/18/16 Added function XHdcp1x_IsEnabled. 2.20
MG 01/20/16 Added function XHdcp1x_GetHdcpCallback. 2.30 MG 02/25/16 Added
function XHdcp1x_SetCallback and AuthenticatedCallback. 2.40 MG 01/29/16 Removed
function XHdcp1x_GetHdcpCallback and added function XHdcp1x_ProcessAKsv 3.0 yas
02/13/16 Upgraded to support HDCP Repeater functionality. Added constants:
XHDCP1X_RPTR_MAX_CASCADE and XHDCP1X_RPTR_MAX_DEVS_COUNT. Added enumeration
type: XHdcp1x_RepeaterStateMachineHandlerType. Added typedef data type
XHdcp1x_Ksv. Added structure XHdcp1x_RepeaterExchange. Updated core structure
XHdcp1x_Tx, XHdcp1x_Rx and XHdcp1x for Repeater support. Added following
functions: XHdcp1x_DownstreamReady, XHdcp1x_GetRepeaterInfo,
XHdcp1x_SetCallBack, XHdcp1x_ReadDownstream. 4.0 yas 06/15/16 Added support for
Cipher Blank Value and select. Extended support for Repeater functionality. 4.0
yas 08/16/16 Used UINTPTR instead of u32 for BaseAddress XHdcp1x_CfgInitialize
4.1 yas 11/10/16 Added function XHdcp1x_SetHdmiMode. 4.1 yas 08/03/17 Added flag
IsAuthReqPending to the XHdcp1x_Tx data structure to track any pending
authentication requests. 4.2 yas 08/13/18 Addded hdcp14_PropagateTopoErrUpstream
flag to track topology failures and ready the topology for the repeater
application to read. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_cipher.c @addtogroup
hdcp1x_v4_2 @{ This file contains the main implementation of the driver
associated with the Xilinx HDCP Cipher core. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 fidus 07/16/15 Initial release. 3.1 yas
06/14/16 Added new functions XHdcp1x_CipherEnableBlank and
XHdcp1x_CipherDisableBlank </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_cipher.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_cipher.h @addtogroup
hdcp1x_v4_2 @{ This is the main header file for Xilinx HDCP Cipher core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 fidus
07/16/15 Initial release. 3.0 yas 02/13/16 Upgraded to support HDCP Repeater
functionality. Added macro HDCP1X_CIPHER_BIT_REPEATER_ENABLE 3.1 yas 06/15/16
Added new functions XHdcp1x_CipherEnableBlank and XHdcp1x_CipherDisableBlank.
</pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_cipher.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_cipher_intr.c
@addtogroup hdcp1x_v4_2 @{ This file contains interrupt related functions for
Xilinx HDCP core. Please see xhdcp1x_cipher.h for more details of the driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
fidus 07/16/15 Initial release. 4.1 yas 08/03/17 Updated the
XHdcp1x_CipherHandleInterrupt function to not mask the interrupts, as it is
being done in hardware now. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_cipher_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_debug.h @addtogroup
hdcp1x_v4_2 @{ This file provides the interface of the HDCP debug commands <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 fidus
07/16/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_hw.h @addtogroup
hdcp1x_v4_2 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx HDCP cipher core.
For more information about the operation of this core see the hardware
specification and documentation in the higher level driver xhdcp1x_ciper.h file.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
fidus 07/16/15 Initial release. 3.10 yas 06/14/16 Added cipher registers
XHDCP1X_CIPHER_REG_BLANK_VALUE and XHDCP1X_CIPHER_REG_BLANK_SEL </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_cipher_intr.c
@addtogroup hdcp1x_v4_2 @{ This file contains interrupt related functions for
Xilinx HDCP core. Please see xhdcp_cipher.h for more details of the driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
fidus 07/16/15 Initial release. 3.0 yas 02/13/16 Added function
XHdcp1x_SetCallBack. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_platform.c @addtogroup
hdcp1x_v4_2 @{ This file provides the implementation for the hdcp platform
integration module <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 fidus 07/16/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_platform.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_platform.h @addtogroup
hdcp1x_v4_2 @{ This file provides the interface for the hdcp platform
integration module <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 fidus 07/16/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_platform.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port.c @addtogroup
hdcp1x_v4_2 @{ This contains the main implementation file for the Xilinx HDCP
Port driver <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 fidus 07/16/15 Initial release. 3.10 yas 07/28/16 Added fucntion
XHdcp1x_PortSetRepeater </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port.h @addtogroup
hdcp1x_v4_2 @{ This header file contains the external declarations associated
with the HDCP port driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 fidus 07/16/15 Initial release. 2.00 MG 01/20/16
Added callback handler to XHdcp1x_PortPhyIfAdaptor 3.10 yas 07/28/16 Added
callback handler SetRepeater to XHdcp1x_PortPhyIfAdaptor </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port_dp.h @addtogroup
hdcp1x_v4_2 @{ This file contains the definitions for the hdcp port
registers/offsets for display port interfaces <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.00 fidus 07/16/15 Initial release. 3.0
yas 02/13/16 Upgraded to support HDCP Repeater functionality. Added macro
defintions for: XHDCP1X_PORT_HDCP_RESET_KSV, XHDCP1X_PORT_SIZE_HDCP_RESET_KSV
and XHDCP1X_PORT_HDCP_RESET_KSV_RST. 3.1 yas 07/28/16 Added Bitmasks for BIFO
register </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port_dp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port_dp_rx.c
@addtogroup hdcp1x_v4_2 @{ This contains the implementation of the HDCP port
driver for Xilinx DP RX interfaces <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 fidus 07/16/15 Initial release. 3.0 yas
02/13/16 Upgraded function XHdcp1x_PortDpRxEnable support HDCP Repeater
functionality. 3.1 yas 07/28/16 Added fucntion XHdcp1x_PortDpRxSetRepeater 4.0
yas 08/16/16 Used UINTPTR instead of u32 for BaseAddress of DisplayPort DPCD
registers </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port_dp_rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port_dp_tx.c
@addtogroup hdcp1x_v4_2 @{ This contains the implementation of the HDCP port
driver for DP TX interfaces <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 fidus 07/16/15 Initial release. </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port_dp_tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port_hdmi.h @addtogroup
hdcp1x_v4_2 @{ This file contains the definitions for the hdcp port
registers/offsets for HDMI interfaces <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 fidus 07/16/15 Initial release. 3.1 yas
07/28/16 Added Bitmasks for BSTATUS register. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port_hdmi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port_hdmi_rx.c
@addtogroup hdcp1x_v4_2 @{ This contains the implementation of the HDCP port
driver for HDMI RX interfaces <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 fidus 07/16/15 Initial release. 2.00 MG 01/20/16
Disabled hdcp call back in function XHdcp1x_PortHdmiRxEnable. 2.10 MG 02/29/16
Added DDC write and read handlers 3.0 yas 02/13/16 Upgraded function
XHdcp1x_PortHdmiRxEnable to support HDCP Repeater functionality. 3.1 yas
07/28/16 Added function XHdcp1x_PortHdmiRxSetRepeater 3.2 yas 10/27/16 Updated
the XHdcp1x_PortHdmiRxDisable function to not clear the AKSV, An and AInfo
values in the DDC space. 4.2 yas 08/15/18 Updated XHdcp1x_PortHdmiRxDisable
function to clear KSV_FIFO. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port_hdmi_rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port_hdmi_tx.c
@addtogroup hdcp1x_v4_2 @{ This contains the implementation of the HDCP port
driver for HDMI TX interfaces <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 fidus 07/16/15 Initial release. 2.00 MG 01/20/16
Assigned callback function in XHdcp1x_PortHdmiTxAdaptor to NULL 2.10 MG 02/29/16
Added DDC write and read handlers </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port_hdmi_tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_port_intr.c @addtogroup
hdcp1x_v4_2 @{ This contains the interrupt related functions of the Xilinx HDCP
port driver <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 fidus 07/16/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_port_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_rx.c @addtogroup
hdcp1x_v4_2 @{ This contains the main implementation file for the Xilinx HDCP
receive state machine <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 fidus 07/16/15 Initial release. 1.10 MG 01/18/16 Added
function XHdcp1x_RxIsEnabled and XHdcp1x_RxIsInProgress. 3.0 yas 02/13/16
Upgraded to support HDCP Repeater functionality. Added a new enum
XHdcp1x_EventType value: XHDCP1X_EVENT_DOWNSTREAMREADY. Added new
XHdcp1x_StateType values: XHDCP1X_STATE_WAITFORDOWNSTREAM,
XHDCP1X_STATE_ASSEMBLEKSVLIST. Added a new function: XHdcp1x_RxDownstreamReady,
XHdcp1x_RxGetRepeaterInfo, XHdcp1x_RxSetCallBack. Updated the following
functions for Repeater: XHdcp1x_RxStartComputations,
XHdcp1x_RxPollForComputations, XHdcp1x_RxEnterState, XHdcp1x_RxDoTheState. 3.1
yas 07/28/16 Repeater functionality extended to support HDMI. Removed the
XHdcp1x_RxDownstreamReadyCallback. Added fucntions,
XHdcp1x_RxSetRepeaterBcaps,XHdcp1x_RxIsInComputations,
XHdcp1x_RxIsInWaitforready, XHdcp1x_RxHandleTimeout, XHdcp1x_RxStartTimer,
XHdcp1x_RxStopTimer, XHdcp1x_RxBusyDelay, XHdcp1x_RxSetTopologyUpdate,
XHdcp1x_RxSetTopology, XHdcp1x_RxSetTopologyKSVList, XHdcp1x_RxSetTopologyDepth,
XHdcp1x_RxSetTopologyDeviceCnt, XHdcp1x_RxSetTopologyMaxCascadeExceeded,
XHdcp1x_RxSetTopologyMaxDevsExceeded, XHdcp1x_RxCheckEncryptionChange. 4.1 yas
11/10/16 Added function XHdcp1x_RxSetHdmiMode. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_rx.h @addtogroup
hdcp1x_v4_2 @{ This file provides the interface of the HDCP RX state machine
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
fidus 07/16/15 Initial release. 1.10 MG 01/18/16 Added function
XHdcp1x_RxIsEnabled and XHdcp1x_RxIsInProgress. 1.20 MG 02/25/16 Added function
XHdcp1x_RxSetCallback. 3.0 yas 02/13/16 Upgraded to support HDCP Repeater
functionality. Added functions: XHdcp1x_RxDownstreamReady,
XHdcp1x_RxGetRepeaterInfo, XHdcp1x_RxDownstreamReadyCallback,
XHdcp1x_RxSetCallBack. 3.1 yas 07/28/16 Repeater functionality extended to
support HDMI. Removed the XHdcp1x_RxDownstreamReadyCallback. Added fucntions,
XHdcp1x_RxSetRepeaterBcaps,XHdcp1x_RxIsInComputations,
XHdcp1x_RxIsInWaitforready, XHdcp1x_RxHandleTimeout, XHdcp1x_RxStartTimer,
XHdcp1x_RxStopTimer, XHdcp1x_RxBusyDelay, XHdcp1x_RxSetTopologyUpdate,
XHdcp1x_RxSetTopology, XHdcp1x_RxSetTopologyKSVList, XHdcp1x_RxSetTopologyDepth,
XHdcp1x_RxSetTopologyDeviceCnt, XHdcp1x_RxSetTopologyMaxCascadeExceeded,
XHdcp1x_RxSetTopologyMaxDevsExceeded, XHdcp1x_RxCheckEncryptionChange. 4.1 yas
11/10/16 Added function XHdcp1x_RxSetHdmiMode. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_rx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_selftest.c @addtogroup
hdcp1x_v4_2 @{ This file contains self test function for the hdcp interface
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
fidus 07/16/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_sinit.c @addtogroup
hdcp1x_v4_2 @{ This file contains static initialization method for Xilinx HDCP
driver <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 fidus 07/16/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_tx.c @addtogroup
hdcp1x_v4_2 @{ This contains the main implementation file for the Xilinx HDCP
transmit state machine <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 fidus 07/16/15 Initial release. 1.10 MG 01/18/16 Added
function XHdcp1x_TxIsEnabled. 1.20 MG 02/25/16 Added function
XHdcp1x_TxSetCallback and authenticated callback. 3.0 yas 02/13/16 Upgraded to
support HDCP Repeater functionality. Added enum XHDCP1X_EVENT_READDOWNSTREAM, of
XHdcp1x_EventType. Added new functions: XHdcp1x_TxReadDownstream,
XHdcp1x_TxSetCallBack, XHdcp1x_TxTriggerDownstreamAuth,
XHdcp1x_TxSetRepeaterInfo. 3.1 yas 06/15/16 Repeater functionality extended to
support HDMI. Added fucntions,
XHdcp1x_TxIsInComputations,XHdcp1x_TxIsInWaitforready,
XHdcp1x_TxIsDownstrmCapable, XHdcp1x_TxIsRepeater, XHdcp1x_TxEnableBlank,
XHdcp1x_TxDisableBlank, XHdcp1x_TxGetTopologyKSVList,
XHdcp1x_TxGetTopologyDepth, XHdcp1x_TxGetTopologyDeviceCnt,
XHdcp1x_TxGetTopologyMaxCascadeExceeded, XHdcp1x_TxGetTopologyBKSV,
XHdcp1x_TxGetTopologyMaxDevsExceeded, XHdcp1x_TxGetTopology 4.1 yas 03/07/17
Updated to remove compliance failures. 4.1 yas 22/04/17 Added function
XHdcp1x_TxSetHdmiMode. 4.1 MH 11/05/17 Update to enable encryption immediately
after Ro' check. Increase timeout for topology propagation. 4.1 yas 08/03/17
Updated the XHdcp1x_TxIsInProgress to track any pending authentication requests.
4.2 yas 08/14/18 Updated the XHdcp1x_TxPollForWaitForReady function to ready
topology in case of a topology error, and make it available in
XHdcp1x_TxGetTopology(). Updating the XHdcp1x_TxReset() to clear the
Authentication Request flag. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp1x_tx.h @addtogroup
hdcp1x_v4_2 @{ This file provides the interface of the HDCP TX state machine
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
fidus 07/16/15 Initial release. 1.10 MG 01/18/16 Added function
XHdcp1x_TxIsEnabled. 1.20 MG 02/25/16 Added function XHdcp1x_TxSetCallback. 3.0
yas 02/13/16 Upgraded to support HDCP Repeater functionality. Added the
following functions: XHdcp1x_TxReadDownstream, XHdcp1x_TxSetCallBack,
XHdcp1x_TxTriggerDownstreamAuth. 3.1 yas 06/15/16 Repeater functionality
extended to support HDMI. Added fucntions,
XHdcp1x_TxIsInComputations,XHdcp1x_TxIsInWaitforready,
XHdcp1x_TxIsDownstrmCapable, XHdcp1x_TxIsRepeater, XHdcp1x_TxEnableBlank,
XHdcp1x_TxDisableBlank, XHdcp1x_TxGetTopologyKSVList,
XHdcp1x_TxGetTopologyDepth, XHdcp1x_TxGetTopologyDeviceCnt,
XHdcp1x_TxGetTopologyMaxCascadeExceeded, XHdcp1x_TxGetTopologyBKSV,
XHdcp1x_TxGetTopologyMaxDevsExceeded, XHdcp1x_TxGetTopology 4.1 yas 22/04/16
Added function XHdcp1x_TxSetHdmiMode. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp1x/src/xhdcp1x_tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher.c @addtogroup
hdcp22_cipher_v1_1 @{ @details This file contains the main implementation of the
Xilinx HDCP 2.2 Cipher device driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 JO 10/01/15 Initial release. 1.10 MH 08/04/16
Added 64 bit address support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher/src/xhdcp22_cipher.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher.h @addtogroup
hdcp22_cipher_v1_1 @{ @details This is the main header file of the Xilinx HDCP
2.2 Cipher device driver. The Cipher implements the AES-128 standard for
encrypting and decrypting audiovisual content. The Cipher is required to be
programmed with the global constant Lc128, random number Riv, and session key Ks
before encryption is enabled. Internally, the cipher uses the Enhanced
Encryption Signaling Status (EESS) to determine when to encrypt and decrypt
frames. It also manages the data and frame counters to ensure the transmitter
and receiver Ciphers are synchronized. <b>Software Initialization and
Configuration</b> The application needs to do the following steps to run the
Cipher. - Call XHdcp22Cipher_LookupConfig using the device ID to find the core
configuration instance. - Call XHdcp22Cipher_CfgInitialize to intitialize the
device instance. - Call XHdcp22Cipher_SetTxMode or XHdcp22Cipher_SetRxMode to
setup the Cipher as either a transmitter or receiver. - Call
XHdcp22Cipher_Enable to enable the cipher. - Call XHdcp22Cipher_SetLc128 to
program the Lc128 constant. - Call XHdcp22Cipher_SetRiv to program the random
number Riv. - Call XHdcp22Cipher_SetKs to program the session key Ks. - If
operating as a transmitter call XHdcp22Cipher_EnableTxEncryption to enable
encryption or XHdcp22Cipher_DisableTxEncryption to disable encryption.
<b>Interrupts</b> None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 JO 10/01/15 Initial release. 1.01 MG 10/28/15 Added Noise
and blank macros 1.02 MG 02/25/15 Added GetVersion macro 1.03 MH 08/04/16 Added
64 bit address support. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher/src/xhdcp22_cipher.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: Driver configuration

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher/src/xhdcp22_cipher_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher_hw.h @addtogroup
hdcp22_cipher_v1_1 @{ @details This header file contains identifiers and
register-level core functions (or macros) that can be used to access the Xilinx
HDCP 2.2 Cipher core. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 JO 10/01/15 Initial release. 1.01 MG 10/28/15 Added
InputCtr register </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher/src/xhdcp22_cipher_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher_selftest.c
@addtogroup hdcp22_cipher_v1_1 @{ @details This file contains self test function
for the Xilinx HDCP 2.2 Cipher core. The self test function reads the version
register. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 JO 10/01/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher/src/xhdcp22_cipher_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher_sinit.c
@addtogroup hdcp22_cipher_v1_1 @{ @details This file contains the static
initialization methods for the Xilinx HDCP 2.2 Cipher core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 JO 10/01/15 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher/src/xhdcp22_cipher_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher.c @addtogroup
hdcp22_cipher_v1_1 @{ @details This file contains the main implementation of the
Xilinx HDCP 2.2 Cipher device driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 JB 02/19/19 Initial Release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/src/xhdcp22_cipher.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher.h @addtogroup
hdcp22_cipher_v1_1 @{ @details This is the main header file of the Xilinx HDCP
2.2 Cipher device driver. The Cipher implements the AES-128 standard for
encrypting and decrypting audiovisual content. The Cipher is required to be
programmed with the global constant Lc128, random number Riv, and session key Ks
before encryption is enabled. Internally, the cipher uses the Enhanced
Encryption Signaling Status (EESS) to determine when to encrypt and decrypt
frames. It also manages the data and frame counters to ensure the transmitter
and receiver Ciphers are synchronized. <b>Software Initialization and
Configuration</b> The application needs to do the following steps to run the
Cipher. - Call XHdcp22Cipher_LookupConfig using the device ID to find the core
configuration instance. - Call XHdcp22Cipher_CfgInitialize to intitialize the
device instance. - Call XHdcp22Cipher_SetTxMode or XHdcp22Cipher_SetRxMode to
setup the Cipher as either a transmitter or receiver. - Call
XHdcp22Cipher_Enable to enable the cipher. - Call XHdcp22Cipher_SetLc128 to
program the Lc128 constant. - Call XHdcp22Cipher_SetRiv to program the random
number Riv. - Call XHdcp22Cipher_SetKs to program the session key Ks. - If
operating as a transmitter call XHdcp22Cipher_EnableTxEncryption to enable
encryption or XHdcp22Cipher_DisableTxEncryption to disable encryption.
<b>Interrupts</b> None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 JB 02/19/19 Initial Release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/src/xhdcp22_cipher.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher_hw.h @addtogroup
hdcp22_cipher_v1_1 @{ @details This header file contains identifiers and
register-level core functions (or macros) that can be used to access the Xilinx
HDCP 2.2 Cipher core. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 JB 02/19/19 Initial Release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/src/xhdcp22_cipher_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher_selftest.c
@addtogroup hdcp22_cipher_v1_1 @{ @details This file contains self test function
for the Xilinx HDCP 2.2 Cipher core. The self test function reads the version
register. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 JB 02/19/19 Initial Release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/src/xhdcp22_cipher_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_cipher_sinit.c
@addtogroup hdcp22_cipher_v1_1 @{ @details This file contains the static
initialization methods for the Xilinx HDCP 2.2 Cipher core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 JB 02/19/19 Initial
Release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_cipher_dp/src/xhdcp22_cipher_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file aes.c This code is the
implementation of the AES algorithm and the CTR, CBC, and CCM modes of operation
it can be used in. AES is, specified by the NIST in in publication FIPS PUB 197,
availible at: - http://csrc.nist.gov/publications/fips/fips197/fips-197.pdf .
The CBC and CTR modes of operation are specified by NIST SP 800-38 A, available
at: - http://csrc.nist.gov/publications/nistpubs/800-38a/sp800-38a.pdf . The CCM
mode of operation is specified by NIST SP80-38 C, available at: -
http://csrc.nist.gov/publications/nistpubs/800-38C/SP800-38C_updated-
July20_2007.pdf <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 MH 10/30/15 First Release 1.01 MH 01/28/17 Fixed warnings and
errors. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_common/src/aes.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/aes.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/aes.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [MPL-2.0]

COPYRIGHT TEXT:
---------------

$Id: bigdigits.c $ / BEGIN LICENSE BLOCK This Source Code Form is subject to the
terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Copyright (c) 2001-15 David Ireland, D.I. Management Services Pty Limited
<http://www.di-mgt.com.au/bigdigits.html>. All rights reserved. END LICENSE
BLOCK / Last updated: $Date: 2015-10-22 10:23:00 $ $Revision: 2.5.0 $ $Author:
dai $ / Core code for BigDigits library "mp" functions /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_common/src/bigdigits.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/bigdigits.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/bigdigits.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/bigdigits.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/bigdigits.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [MPL-2.0]

COPYRIGHT TEXT:
---------------

$Id: bigdigits.h $ / @file Interface to core BigDigits "mp" functions using
fixed-length arrays BEGIN LICENSE BLOCK This Source Code Form is subject to the
terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Copyright (c) 2001-15 David Ireland, D.I. Management Services Pty Limited
<http://www.di-mgt.com.au/bigdigits.html>. All rights reserved. END LICENSE
BLOCK / Last updated: $Date: 2015-10-22 10:23:00 $ $Revision: 2.5.0 $ $Author:
dai $ /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_common/src/bigdigits.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/bigdigits.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/bigdigits.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/bigdigits.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/bigdigits.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [MPL-2.0]

COPYRIGHT TEXT:
---------------

$Id: bigdtypes.h $ / BEGIN LICENSE BLOCK This Source Code Form is subject to the
terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Copyright (c) 2001-15 David Ireland, D.I. Management Services Pty Limited
<http://www.di-mgt.com.au/bigdigits.html>. All rights reserved. END LICENSE
BLOCK / Last updated: $Date: 2015-10-22 10:23:00 $ $Revision: 2.5.0 $ $Author:
dai $ /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_common/src/bigdtypes.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/bigdtypes.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/bigdtypes.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/bigdtypes.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/bigdtypes.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file hmac.c This file contains the
implementation of the HMAC Hash Message Authentication Code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 MH 10/30/15 First Release
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_common/src/hmac.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/hmac.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/hmac.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sha2.c This file contains the
implementation of the SHA-2 Secure Hashing Algorithm. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 MH 10/30/15 First Release
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_common/src/sha2.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/sha2.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/sha2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_common.h This file
contains common functions shared between HDCP22 drivers. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 MH 10/30/15 First
Release. 1.01 MH 01/15/16 Added prefix to function names. 2.00 MH 06/21/17
Changed DIGIT_T type to u32 for ARM support. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_common/src/xhdcp22_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_mmult.c @addtogroup
hdcp22_mmult_v1_1 @{ @details This file contains the main implementation of the
driver associated with the Xilinx HDCP 2.2 Montgomery Multiplier core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 MH
12/07/15 Initial release. 1.01 MH 08/04/16 Added 64 bit address support. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_mmult/src/xhdcp22_mmult.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_mmult.h @addtogroup
hdcp22_mmult_v1_1 @{ @details This is the main header file for the Xilinx HDCP
2.2 Montgomery Multipler device driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 MH 12/07/15 Initial release. 1.01 MH 08/04/16
Added 64 bit address support. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_mmult/src/xhdcp22_mmult.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_mmult_hw.h @addtogroup
hdcp22_mmult_v1_1 @{ @details This header file contains identifiers and
register-level core functions (or macros) that can be used to access the Xilinx
HDCP22 Montgomery Multipler (Mmult) core. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 MH 12/07/15 Initial release. </pre> CTRL
0x000 : Control signals bit 0 - ap_start (Read/Write/COH) bit 1 - ap_done
(Read/COR) bit 2 - ap_idle (Read) bit 3 - ap_ready (Read) bit 7 - auto_restart
(Read/Write) others - reserved 0x004 : Global Interrupt Enable Register bit 0 -
Global Interrupt Enable (Read/Write) others - reserved 0x008 : IP Interrupt
Enable Register (Read/Write) bit 0 - Channel 0 (ap_done) bit 1 - Channel 1
(ap_ready) others - reserved 0x00c : IP Interrupt Status Register (Read/TOW) bit
0 - Channel 0 (ap_done) bit 1 - Channel 1 (ap_ready) others - reserved 0x040 ~
0x07f : Memory 'U' (16 32b) Word n : bit [31:0] - U[n] 0x080 ~ 0x0bf : Memory
'A' (16 32b) Word n : bit [31:0] - A[n] 0x0c0 ~ 0x0ff : Memory 'B' (16 32b) Word
n : bit [31:0] - B[n] 0x100 ~ 0x13f : Memory 'N' (16 32b) Word n : bit [31:0] -
N[n] 0x140 ~ 0x17f : Memory 'NPrime' (16 32b) Word n : bit [31:0] - NPrime[n]
(SC Self Clear, COR Clear on Read, TOW Toggle on Write, COH Clear on Handshake)

FILES:
XilinxProcessorIPLib/drivers/hdcp22_mmult/src/xhdcp22_mmult_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_mmult_linux.c
@addtogroup hdcp22_mmult_v1_1 @{ @details This file contains the linux support
for the driver associated with the Xilinx HDCP22 Montgomery Multiplier (Mmult)
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 MH 12/07/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_mmult/src/xhdcp22_mmult_linux.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_mmult_sinit.c
@addtogroup hdcp22_mmult_v1_1 @{ @details This file contains the static
initialization file for the Xilinx Montgomery Multiplier (Mmult) core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 MH
10/01/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_mmult/src/xhdcp22_mmult_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rng.c @addtogroup
hdcp22_rng_v1_2 @{ @details This file contains the main implementation of the
Xilinx HDCP 2.2 RNG device driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 JO 10/01/15 Initial release. 1.01 MH 08/04/16
Added 64 bit address support. 1.02 MH 02/17/16 Fixed pointer alignment problem
in function XHdcp22Rng_GetRandom </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rng/src/xhdcp22_rng.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rng.h @addtogroup
hdcp22_rng_v1_2 @{ @details This is the main header file of the Xilinx HDCP 2.2
RNG device driver. The RNG is a random number generator, which is used to
produce random numbers during the authentication and key exchange. <b>Software
Initialization and Configuration</b> The application needs to do the following
steps to run the RNG. - Call XHdcp22Rng_LookupConfig using the device ID to find
the core configuration instance. - Call XHdcp22Rng_CfgInitialize to intitialize
the device instance. - Call XHdcp22Rng_Enable to enable the device. - Call
XHdcp22Rng_GetRandom to get random words. <b>Interrupts</b> None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 JO
10/01/15 Initial release. 1.01 MH 08/04/16 Added 64 bit address support. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rng/src/xhdcp22_rng.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rng_hw.h @addtogroup
hdcp22_rng_v1_2 @{ @details This header file contains identifiers and register-
level core functions (or macros) that can be used to access the Xilinx HDCP 2.2
RNG core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 JO 10/01/15 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rng/src/xhdcp22_rng_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rng_selftest.c
@addtogroup hdcp22_rng_v1_2 @{ @details This file contains the self test
function for the HDCP 2.2 RNG core. The self test function reads the version
register. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 JO 10/01/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rng/src/xhdcp22_rng_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rng_sinit.c @addtogroup
hdcp22_rng_v1_2 @{ @details This file contains the static initialization methods
for the Xilinx HDCP 2.2 RNG core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 JO 10/01/15 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rng/src/xhdcp22_rng_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains the main implementation of the
Xilinx HDCP 2.2 Receiver device driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 MH 10/30/15 First Release 1.01 MH 01/15/16
Updated function XHdcp22Rx_SetDdcReauthReq to remove static. Replaced function
XHdcp22Rx_SetDdcHandles with XHdcp22Rx_SetCallback. Added callback for
authenticated event. 1.02 MH 03/02/16 Updated to perform Montgomery NPrime
calcuation when XHdcp22Rx_LoadPrivateKey is called. Added function
XHDCP22Rx_GetVersion. 1.03 MH 03/15/16 Fixed XHdcp22Rx_SetLinkError and
XHdcp22Rx_SetDdcError functions to update error flag. 2.00 MH 04/14/16 Updated
for repeater upstream support. 2.01 MH 02/28/17 Fixed compiler warnings. 2.20 MH
06/08/17 Updated for 64 bit support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx/src/xhdcp22_rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx.h @addtogroup
hdcp22_rx_v2_2 @{ @details This is the main header file for the Xilinx HDCP 2.2
Receiver device driver. The HDCP 2.2 Receiver driver implements the
authentication state machine. It consists of: - A state machine handling the
states as specified in the HDCP revision 2.2 specification. - Message handling
from/to the HDCP 2.2 transmitter. - Logging functionality including time stamps.
<b>Software Initialization and Configuration</b> The application needs to do the
following steps to run the Receiver. - Call XHdcp22Rx_LookupConfig using the
device ID to find the core configuration instance. - Call
XHdcp22Rx_CfgInitialize to intitialize the device instance. - Call
XHdcp22Rx_SetCallback to set the pointers to the callback functions defined by
the enumerated type XHdcp22_Rx_HandlerType. - Call XHdcp22Rx_LoadPublicCert to
load the DCP public certificate. - Call XHdcp22Rx_LoadPrivateKey to load the RSA
private key. - Call XHdcp22Rx_LoadLc128 to load the DCP global constant. - Call
XHdcp22Rx_LogReset to reset the log buffer. - The following functions should be
called in the interfacing protocol driver (i.e. HDMI) to set event flags: -
XHdcp22Rx_SetLinkError - XHdcp22Rx_SetDdcError -
XHdcp22Rx_SetWriteMessageAvailable - XHdcp22Rx_SetReadMessageComplete - Call
XHdcp22Rx_Enable to enable the state machine. - Call XHdcp22Rx_Poll to run the
Receiver state machine. The call to this function is non-blocking and should be
called repeatedly in a spin loop as long as the receiver is active.
<b>Interrupts</b> None. <b> Threads </b> This driver is not thread safe. Any
needs for threads or thread mutual exclusion must be satisfied by the layer
above this driver. <b> Asserts </b> Asserts are used within all Xilinx drivers
to enforce constraints on argument values. Asserts can be turned off on a
system-wide basis by defining at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The HDCP TX driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 MH 10/30/15 First Release 1.01 MH 01/15/16
Added XHdcp22Rx_SetDdcReauthReq to function prototypes. Replaced function
XHdcp22Rx_SetDdcHandles with XHdcp22Rx_SetCallback. 1.02 MH 03/02/16 Updated to
change NPrimeP and NPrimeQ from pointer to array. Added function
XHDCP22Rx_GetVersion. 2.00 MH 04/14/16 Updated for repeater upstream support.
2.01 MH 02/28/17 Fixed compiler warnings. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx/src/xhdcp22_rx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_crypt.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains the implementation of the PKCS 1
Public Key Cryptography Standard and other cryptographic functions used during
HDCP 2.2 receiver authentication and key exchange. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 MH 10/30/15 First Release 2.00 MH
04/14/16 Updated for repeater upstream support. 2.20 MH 06/21/17 Updated for 64
bit support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx/src/xhdcp22_rx_crypt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_i.h @addtogroup
hdcp22_rx_v2_2 @{ @details This header file contains internal data types and
functions declarations for the Xilinx HDCP 2.2 Receiver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 MH 10/30/15 First Release
1.01 MH 03/02/16 Moved prototype of XHdcp22Rx_CalcMontNPrime to to internal
functions. 1.02 MH 04/14/16 Updated for repeater upstream support. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx/src/xhdcp22_rx_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_sinit.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains static initialization method for
Xilinx HDCP 2.2 Receiver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 MH 10/30/15 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx/src/xhdcp22_rx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_test.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains the implementation of the test
framework used to perform standalone receiver testing and software loopback
testing for the Xilinx HDCP 2.2 Receiver. The test vectors and keys contained in
this file are from the Errata to HDCP on HDMI Specification Revision 2.2,
Feburary 09, 2015. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 MH 10/30/15 First Release 2.00 MH 04/14/16 Updated for repeater
upstream support. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx/src/xhdcp22_rx_test.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains the main implementation of the
Xilinx HDCP 2.2 Receiver device driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 JB 02/19/19 First Release. </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/src/xhdcp22_rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx.h @addtogroup
hdcp22_rx_v2_2 @{ @details This is the main header file for the Xilinx HDCP 2.2
Receiver device driver. The HDCP 2.2 Receiver driver implements the
authentication state machine. It consists of: - A state machine handling the
states as specified in the HDCP revision 2.2 specification. - Message handling
from/to the HDCP 2.2 transmitter. - Logging functionality including time stamps.
<b>Software Initialization and Configuration</b> The application needs to do the
following steps to run the Receiver. - Call XHdcp22Rx_LookupConfig using the
device ID to find the core configuration instance. - Call
XHdcp22Rx_CfgInitialize to intitialize the device instance. - Call
XHdcp22Rx_SetCallback to set the pointers to the callback functions defined by
the enumerated type XHdcp22_Rx_HandlerType. - Call XHdcp22Rx_LoadPublicCert to
load the DCP public certificate. - Call XHdcp22Rx_LoadPrivateKey to load the RSA
private key. - Call XHdcp22Rx_LoadLc128 to load the DCP global constant. - Call
XHdcp22Rx_LogReset to reset the log buffer. - The following functions should be
called in the interfacing protocol driver (i.e. HDMI) to set event flags: -
XHdcp22Rx_SetLinkError - XHdcp22Rx_SetDdcError -
XHdcp22Rx_SetWriteMessageAvailable - XHdcp22Rx_SetReadMessageComplete - Call
XHdcp22Rx_Enable to enable the state machine. - Call XHdcp22Rx_Poll to run the
Receiver state machine. The call to this function is non-blocking and should be
called repeatedly in a spin loop as long as the receiver is active.
<b>Interrupts</b> None. <b> Threads </b> This driver is not thread safe. Any
needs for threads or thread mutual exclusion must be satisfied by the layer
above this driver. <b> Asserts </b> Asserts are used within all Xilinx drivers
to enforce constraints on argument values. Asserts can be turned off on a
system-wide basis by defining at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The HDCP TX driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 JB 02/19/19 First Release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/src/xhdcp22_rx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_crypt.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains the implementation of the PKCS 1
Public Key Cryptography Standard and other cryptographic functions used during
HDCP 2.2 receiver authentication and key exchange. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 JB 02/19/19 First Release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/src/xhdcp22_rx_crypt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_i.h @addtogroup
hdcp22_rx_v2_2 @{ @details This header file contains internal data types and
functions declarations for the Xilinx HDCP 2.2 Receiver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 JB 02/19/19 First
Release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/src/xhdcp22_rx_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_sinit.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains static initialization method for
Xilinx HDCP 2.2 Receiver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 JB 02/19/19 First Release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/src/xhdcp22_rx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_rx_test.c @addtogroup
hdcp22_rx_v2_2 @{ @details This file contains the implementation of the test
framework used to perform standalone receiver testing and software loopback
testing for the Xilinx HDCP 2.2 Receiver. The test vectors and keys contained in
this file are from the Errata to HDCP on HDMI Specification Revision 2.2,
Feburary 09, 2015. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 JB 02/19/19 First Release. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_rx_dp/src/xhdcp22_rx_test.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx.c @addtogroup
hdcp22_tx_v2_3 @{ @details This file contains the main implementation of the
Xilinx HDCP 2.2 Transmitter device driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 JO 06/24/15 Initial release. 1.01 MH
01/15/16 Replaced function XHdcp22Tx_SetDdcHandles with XHdcp22Tx_SetCallback.
Removed test directives. 1.02 MG 02/25/16 Added authenticated callback and
GetVersion. 1.03 MG 02/29/16 Added XHdcp22Cipher_Disable in function
XHdcp22Tx_Reset. 1.04 MH 03/14/16 Updated StateA5 to check re-authentication
request before enabling the cipher. 2.00 MH 06/28/16 Updated for repeater
downstream support. 2.01 MH 02/13/17 1. Fixed function XHdcp22Tx_IsInProgress to
correctly return TRUE while state machine is executing. 2. Fixed checking of
seq_num_V for topology propagation. 3. Updated state A0 to set 100ms timer
before sending AKE_Init message to ensure encryption is disabled. 4. Fixed
function XHdcp22Tx_UpdatePairingInfo to check for empty slots before overriding
entry. 5. Fixed problem with pairing table update that was causing corrupted
entries. 6. Update to check return status of DDC read/write. 7. Fixed compiler
warnings. 2.20 MH 04/12/17 Added function XHdcp22Tx_IsDwnstrmCapable. 2.30 MH
07/06/17 1. Updated for 64 bit ARM support. 2. Added HDCP2Capable check for re-
authentication 3. Update cipher enablement 4. Fix in XHdcp22Tx_WaitForReceiver
to poll RxStatus based on fixed interval. 5. Fix in XHdcp22Tx_WaitForReceiver to
wait for READY and non-zero Message_Size before reading message buffer. 6. Check
return status of DDC write/read when polling RxStatus register. 2.31 YB 03/28/19
Moved the reading of the DDC status from XHdcp22Tx_TimerHandler to
XHdcp22Tx_Poll. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx/src/xhdcp22_tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx.h @addtogroup
hdcp22_tx_v2_3 @{ @details This is the main header file for Xilinx HDCP 2.2
Transmiter device driver. The HDCP 2.2 Transmitter driver implements the
authentication state machine. It consists of: - A state machine handling the
states as specified in the HDCP revision 2.2 specification. - Functionality for
checking if the HDCP 2.2 Receiver sink does respond within specified times. -
Message handling from/to the HDCP 2.2 receiver sink. - Logging functionality
including time stamps. <b>Interrupts </b> The driver uses a hardware timer
interrupt. The interrupt controller that should be used, must be passed with the
XHdcp22Tx_SetInterruptController function. Application developer needs to
register interrupt handler with the processor, within their examples. Whenever
processor calls registered application's interrupt handler associated with
interrupt id, application's interrupt handler needs to call appropriate
peripheral interrupt handler reading peripheral's Status register. <b> Threads
</b> This driver is not thread safe. Any needs for threads or thread mutual
exclusion must be satisfied by the layer above this driver. <b> Asserts </b>
Asserts are used within all Xilinx drivers to enforce constraints on argument
values. Asserts can be turned off on a system-wide basis by defining at compile
time, the NDEBUG identifier. By default, asserts are turned on and it is
recommended that users leave asserts on during development. <b> Building the
driver </b> The HDCP TX driver is composed of several source files. This allows
the user to build and link only those parts of the driver that are necessary.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 JO
06/24/15 Initial release. 1.01 MG 02/25/16 Added authenticated callback and
GetVersion. 2.00 MH 06/28/16 Updated for repeater downstream support. 2.01 MH
02/28/17 Fixed compiler warnings. 2.20 MH 04/12/17 Added function
XHdcp22Tx_IsDwnstrmCapable. 2.30 MH 07/06/17 Changed default polling value to 10
ms. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx/src/xhdcp22_tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx_crypt.c @addtogroup
hdcp22_tx_v2_3 @{ @details This is the file for Xilinx HDCP 2.2 transmitter
cryptographic functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 JO 10/06/15 Initial release. 1.01 MH 01/15/16
Replaced mallocs with fixed size arrays. 2.00 MH 06/28/16 Updated for repeater
downstream support. 2.30 MH 05/16/16 1. Reduced BD_MAX_MOD_SIZE to optimize
stack size. 2. Updated for 64 bit support. 2.40 MH 01/30/18 Added function
XHdcp22Tx_RsaSignatureVerify. Signature verification has been updated to check
entire encoded message EM including padding PS. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx/src/xhdcp22_tx_crypt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx_i.h @addtogroup
hdcp22_tx_v2_3 @{ @details This file contains data which is shared between files
and internal to the XIntc component. It is intended for internal use only. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 JO
06/24/15 Initial release. 1.01 MH 03/14/15 Changed maximum locality check count
from 1024 to 128. 2.00 MH 06/28/16 Updated for repeater downstream support. 2.01
MH 02/13/17 1. Updated maximum locality check count from 128 to 8 to avoid
delays in re-auth. 2. Added log events for failures. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx/src/xhdcp22_tx_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx_sinit.c @addtogroup
hdcp22_tx_v2_3 @{ @details This file contains static initialization method for
Xilinx HDCP 2.2 Transmitter driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 JO 16/06/15 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx/src/xhdcp22_tx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx_test.c @addtogroup
hdcp22_tx_v2_3 @{ @details This is a test and logging file for the Xilinx HDCP
2.2 transmitter core. Testing is done by acting as a stub for the DDC handlers.
Some functions return a test-vector as specified by the "Errata to HDCP on HDMI
Specification Revision 2.2" document. Further logging functionality is
available, using a buffer for logging events. The log buffer also acts as a
results buffer for unit tests. A unit test can execute authentication, and check
if the results in the log-buffer match the expected results. Using test flags,
some errors can be simulated. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 JO 06/17/15 Initial release. 2.00 MH 06/28/16 Updated
for repeater downstream support. </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx/src/xhdcp22_tx_test.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx.c @addtogroup
hdcp22_tx_v2_3 @{ @details This file contains the main implementation of the
Xilinx HDCP 2.2 Transmitter device driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 jb 02/21/19 Initial release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/src/xhdcp22_tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx.h @addtogroup
hdcp22_tx_v2_3 @{ @details This is the main header file for Xilinx HDCP 2.2
Transmiter device driver. The HDCP 2.2 Transmitter driver implements the
authentication state machine. It consists of: - A state machine handling the
states as specified in the HDCP revision 2.2 specification. - Functionality for
checking if the HDCP 2.2 Receiver sink does respond within specified times. -
Message handling from/to the HDCP 2.2 receiver sink. - Logging functionality
including time stamps. <b>Interrupts </b> The driver uses a hardware timer
interrupt. The interrupt controller that should be used, must be passed with the
XHdcp22Tx_SetInterruptController function. Application developer needs to
register interrupt handler with the processor, within their examples. Whenever
processor calls registered application's interrupt handler associated with
interrupt id, application's interrupt handler needs to call appropriate
peripheral interrupt handler reading peripheral's Status register. <b> Threads
</b> This driver is not thread safe. Any needs for threads or thread mutual
exclusion must be satisfied by the layer above this driver. <b> Asserts </b>
Asserts are used within all Xilinx drivers to enforce constraints on argument
values. Asserts can be turned off on a system-wide basis by defining at compile
time, the NDEBUG identifier. By default, asserts are turned on and it is
recommended that users leave asserts on during development. <b> Building the
driver </b> The HDCP TX driver is composed of several source files. This allows
the user to build and link only those parts of the driver that are necessary.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 jb
02/21/19 Initial release </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/src/xhdcp22_tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx_crypt.c @addtogroup
hdcp22_tx_v2_3 @{ @details This is the file for Xilinx HDCP 2.2 transmitter
cryptographic functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 jb 02/21/19 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/src/xhdcp22_tx_crypt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx_i.h @addtogroup
hdcp22_tx_v2_3 @{ @details This file contains data which is shared between files
and internal to the XIntc component. It is intended for internal use only. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 jb
02/21/19 Initial release </pre>

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/src/xhdcp22_tx_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_tx_sinit.c @addtogroup
hdcp22_tx_v2_3 @{ @details This file contains static initialization method for
Xilinx HDCP 2.2 Transmitter driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 jb 02/21/19 Initial release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/hdcp22_tx_dp/src/xhdcp22_tx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY 10.0 6/30/14
Removed support for EDK cores. 11.2 02/01/19 Updated the Number of words per
frame as mention in the ug570

FILES:
XilinxProcessorIPLib/drivers/hwicap/data/hwicap.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 9.0 adk 12/10/13 Updated as per the New Tcl
API's 9.0 bss 02/20/14 Added kintex 8 and kintexu families 10.0 bss 06/24/14
Modified not to generate family.h so that all families are allowed. Tcl
procedure generate

FILES:
XilinxProcessorIPLib/drivers/hwicap/data/hwicap.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 9.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_I_SP1 - Added support for generation of multiple
applications. All TCL procedures are now required to have a software project
type as its first argument @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl
Software Project Types (swproj): 0 : MemoryTest - Calls basic memorytest
routines from common driver dir 1 : PeripheralTest - Calls any existing
polled_example and/or selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/hwicap/data/hwicap_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_intr_example.c This
file contains a design example using the HwIcap driver (XHwIcap) and the HwIcap
device using the interrupt mode. @note None. WARNING This is not an example that
can be used directly. This example gives the sequence of steps that need to be
done for programming the FPGA with a given configuration(partial) file. This
configuration file differs from each system and each version of the FPGA device.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 2.00a sv
09/29/07 First release 4.00a hvm 12/1/09 Updated with HAL phase 1 changes 5.00a
hvm 2/25/10 Updated with S6 support 10.0 bss 6/24/14 Removed support for
families older than 7 series 11.0 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. 11.2 Nava 30/01/19 Replaced error
with pragma message since the information related to error is not an error info.
It provides an information about the example behaviour. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/examples/xhwicap_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_low_level_example.c
Contains a design example of how to use the low-level macros and functions of
the XHwIcap driver. This example reads back the value stored in the IDCODE
register. This example assumes that there is a UART Device or STDIO Device in
the hardware system. @note This example can be run on a 7 series device, Zynq
device, Ultrascale and ZynqMP Ultrascale FPGAs. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a bjb 11/21/03 First release 1.00a sv
07/18/05 Minor changes to comply to Doxygen and coding guidelines 1.01a sv
04/10/07 Changes to support V4 2.00a sv 10/10/07 Changes to support V5 4.00a hvm
11/20/09 Added support for V6 and updated with HAL phase 1 modifications 5.00a
hvm 02/08/10 Added support for S6 5.00a hvm 04/28/10 Added Check for the control
bit clearance in the CR register for regsiter read and write operations. 5.00a
hvm 05/04/10 Updated the example to read Id twice so as to igonore the first
read. 5.00a hvm 05/21/10 Updated the ID sequence to be consistent across
V4/V5/V6 devices. Added an extra NOP before Type1 Read device ID and removed
extra NOP after the device ID. This change removed the need of reading ID twice.
Removed the extra read ID. 5.01a hvm 07/29/10 Code to check whether read/write
bit in control register is cleared after the initiation of respective transfer
is added for all devices. This check was earlier done only for S6 devices 6.00a
hvm 08/05/11 Added support for K7 family 10.0 bss 6/24/14 Removed support for
families older than 7 series 11.0 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/examples/xhwicap_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xhwicap_read_config_reg_example.c This file contains a design example using the
HwIcap driver and hardware device. This example prints out the values of all the
configuration registers in the FPGA. This example assumes that there is a UART
Device or STDIO Device in the hardware system. @note This example can be run on
a 7 series device, Zynq device, Ultrascale and ZynqMP Ultrascale FPGAs. In a
Zynq device the ICAP needs to be selected using the XDcfg_SelectIcapInterface
API of the DevCfg driver (clear the PCAP_PR bit of Control register in the
Device Config Interface) before it can be accessed using the HwIcap. In case of
ZynqMP clear the PCAP_PR bit of pcap_ctrl register in Module Configuration
Security Unit(CSU) using register write. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a bjb 11/21/03 First release 1.00a sv
07/18/05 Minor changes to comply to Doxygen and coding guidelines 1.01a sv
04/10/07 Changes to support V4 4.00a hvm 11/30/09 Added support for V6 and
updated with HAL phase 1 modifications 5.00a hvm 04/28/10 Added support for S6
support. 6.00a hvm 08/05/11 Added support for K7 family 8.01a bss 05/14/12
Replaced the define XHI_C0R_1 with XHI_COR_1 for CR718042 10.0 bss 6/24/14
Removed support for families older than 7 series 11.0 ms 01/23/17 Added
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028.
11.2 Nava 30/01/19 Rename the example since sdk is expecting _example extension
to support the import examples feature from system.mss file. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/examples/xhwicap_read_config_reg_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xhwicap_read_frame_polled_example.c The is example shows how to use the
XHwIcap_DeviceReadFrame() to read a frame of data. This example simply reads one
frame from the device using the polled mode. This example assumes that there is
a UART Device or STDIO Device in the hardware system. @note This example should
run on any Virtex4 or Virtex5 or Virtex6 or Spartan6 or Kintex 7 device. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a bjb
11/21/03 First release 1.00a sv 07/18/05 Minor changes to comply to Doxygen and
coding guidelines 1.01a sv 04/10/07 Changes to support V4 2.00a sv 10/04/07
Changes to support FIFO mode 4.00a hvm 11/20/09 Updated to support V6 5.00a hvm
2/20/10 Updated to support S6. 6.00a hvm 08/05/11 Added support for K7 family
10.0 bss 6/24/14 Removed support for families older than 7 series </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/examples/xhwicap_read_frame_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_testapp_example.c This
file contains a design example using the HwIcap device driver and hardware
device. @note This example can be run on a 7 series device, Zynq device,
Ultrascale and ZynqMP Ultrascale FPGAs. In a Zynq device the ICAP needs to be
selected using the XDcfg_SelectIcapInterface API of the DevCfg driver (clear the
PCAP_PR bit of Control register in the Device Config Interface) before it can be
accessed using the HwIcap. In case of ZynqMP clear the PCAP_PR bit of pcap_ctrl
register in Module Configuration Security Unit(CSU) using register write. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 2.00a sv 10/04/07
Initial release. 11.0 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/examples/xhwicap_testapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap.c @addtogroup
hwicap_v11_2 @{ This file contains the functions of the XHwIcap driver. See
xhwicap.h for a detailed description of the driver. @note 7 series device, Zynq
device, Ultrascale and ZynqMP Ultrascale are supported. In a Zynq device the
ICAP needs to be selected using the XDcfg_SelectIcapInterface API of the DevCfg
driver (clear the PCAP_PR bit of Control register in the Device Config
Interface) before it can be accessed using the HwIcap. In case of ZynqMP clear
the PCAP_PR bit of pcap_ctrl register in Module Configuration Security Unit(CSU)
using register write. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 2.00a sv 09/11/07 Initial version. 2.01a ecm 04/08/08 Updated data
structures to include the V5FXT parts. 3.00a sv 11/28/08 Added the API for
initiating Abort while reading/writing from the ICAP. 4.00a hvm 12/1/09 Added
support for V6 and updated with HAL phase 1 modifications 5.00a hvm 04/02/10
Added support for S6 device. 5.01a hvm 07/06/10 In XHwIcap_DeviceRead function,
a read bit mask verification is added after all the data bytes are read from
READ FIFO.The Verification of the read bit mask at the begining of reading of
bytes is removed. 5.03a hvm 15/4/11 Updated with V6 CXT device definitions.
6.00a hvm 08/01/11 Added support for K7 devices. 7.00a bss 03/14/12 Added
support for 8/16/32 ICAP Data Widths - CR 620085 Added support for Lite Mode(no
Write FIFO) - CR 601748 Added Virtex 7, Artix 7 and Zynq Idcodes in Device look
up table - CR 647140, CR 643295 8.01a bss 04/18/13 Updated to fix compiler
warnings. CR704814 9.0 bss 02/20/14 Updated to support Kintex8, kintexu and
virtex72000T family devices. 10.0 bss 6/24/14 Removed support for families older
than 7 series Removed IDCODE lookup logic in XHwIcap_CfgInitialize. 10.0 bss
7/10/14 Fix compilation failure for designs other than 32 bit data width of
HWICAP. 10.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425.
Changed the prototype of XHwIcap_CfgInitialize API. 10.2 mi 09/22/16 Fixed
compilation warnings. 11.0 MNK 12/06/16 Added support for 8-series family
devices. 11.1 sg 08/29/17 Updated software reset and fifo flush api by adding
delay as per IP specifications 11.2 Nava 02/01/19 Updated the Number of words
per frame as mention in the ug570 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap.h @addtogroup
hwicap_v11_2 @{ @details The Xilinx XHwIcap driver supports the Xilinx Hardware
Internal Configuration Access Port (HWICAP) device. The HWICAP device is used
for reconfiguration of select FPGA resources as well as loading partial
bitstreams from the system memory through the Internal Configuration Access Port
(ICAP). <b> Initialization and Configuration </b> The device driver enables
higher layer software (e.g., an application) to communicate to the HWICAP
device. XHwIcap_CfgInitialize() API is used to initialize the HWICAP device. The
user needs to first call the XHwIcap_LookupConfig() API which returns the
Configuration structure pointer which is passed as a parameter to the
XHwIcap_CfgInitialize() API. <b> Interrupts </b> The driver provides an
interrupt handler XHwIcap_IntrHandler for handling the interrupt from the HWICAP
device. The users of this driver have to register this handler with the
interrupt system and provide the callback functions. The callback functions are
invoked by the interrupt handler based on the interrupt source. The driver
supports interrupt mode only for writing to the ICAP device and is NOT supported
for reading from the ICAP device. <b> Virtual Memory </b> This driver supports
Virtual Memory. The RTOS is responsible for calculating the correct device base
address in Virtual Memory space. <b> Threads </b> This driver is not thread
safe. Any needs for threads or thread mutual exclusion must be satisfied by the
layer above this driver. <b> Asserts </b> Asserts are used within all Xilinx
drivers to enforce constraints on argument values. Asserts can be turned off on
a system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The XHwIcap driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. @note There are a few items to be aware of
when using this driver: 1) Only Virtex4, Virtex5, Virtex6, Spartan6, 7 series
and Zynq devices are supported. 2) The ICAP port is disabled when the
configuration mode, via the MODE pins, is set to Boundary Scan/JTAG. The ICAP is
enabled in all other configuration modes and it is possible to configure the
device via JTAG in all configuration modes. 3) Reading or writing to columns
containing SRL16's or LUT RAM's can cause corruption of data in those elements.
Avoid reading or writing to columns containing SRL16's or LUT RAM's. 4) Only the
LUT and SRL are accesible, all other features of the slice are not available
through this interface. 5) The Spartan6 devices access is 16-bit access and is
32 bit for all other devices. 6) In a Zynq device the ICAP needs to be selected
using the XDcfg_SelectIcapInterface API of the DevCfg driver (clear the PCAP_PR
bit of Control register in the Device Config Interface) before it can be
accessed using the HwIcap. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a bjb 11/17/03 First release 1.01a bjb 04/10/06 V4
Support 2.00a sv 09/28/07 First release for the FIFO mode 2.01a ecm 04/08/08
Updated data structures to include the V5FXT parts. 3.00a sv 11/28/08 Added the
API for initiating Abort while reading/writing from the ICAP. 3.01a sv 10/21/09
Corrected the IDCODE definitions for some of the V5 FX parts in xhwicap_l.h.
Corrected the V5 BOOTSTS and CTL_1 Register definitions in xhwicap_i.h file as
they were wrongly defined. 4.00a hvm 12/1/09 Added support for V6 and updated
with HAL phase 1 modifications 5.00a hvm 04/02/10 Added S6 device support 5.01a
hvm 07/06/10 In XHwIcap_DeviceRead function, a read bit mask verification is
added after all the data bytes are read from READ FIFO.The Verification of the
read bit mask at the begining of reading of bytes is removed. Removed the code
that adds wrong data byte before the CRC bytes in the XHwIcap_DeviceWriteFrame
function for S6 (CR560534). 5.02a hvm 10/06/10 Updated to support AXI HWICAP
5.03a hvm 15/4/11 Updated with V6 CXT device definitions. 6.00a hvm 08/01/11
Added support for K7 devices. 7.00a bss 03/14/12 Added support for 8/16/32 ICAP
Data Widths - CR 620085 Added support for Lite Mode(no Write FIFO) - CR 601748
Added Virtex7,Artix7 and Zynq Idcodes-CR647140,CR643295 ReadId API is added to
desync after lock up during configuration CR 637538 8.00a bss 06/20/12 Deleted
ReadId API in xhwicap_srp.c and Hang mask definition in xhwicap_l.h as per CR
656162 8.01a bss 04/18/13 Updated xhwicap.c to fix compiler warnings. CR704814
Added the define XHI_COR_1 for CR718042 9.0 adk 19/12/13 Updated as per the New
Tcl API's 9.0 bss 02/20/14 Modified xhwicap.c, xhwicap_l.h, xhwicap_i.h and tcl
to support Kintex8, kintexu and virtex72000T family devices. 10.0 bss 6/24/14
Removed support for families older than 7 series. Modified driver tcl not to
generate family.h. Removed IDCODE lookup logic in XHwIcap_CfgInitialize in
xhwicap.c. Removed IDCODE macros from xhwicap_i.h. 10.0 bss 7/10/14 Fix
compilation failure for designs other than 32 bit data width of HWICAP in
xhwicap.c. 10.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR
867425. Changed the prototype of XHwIcap_CfgInitialize API. 10.1 nsk 01/06/16
Removed xhwicap_clb_srinv.h, xhwicap_clb_ff.h, xhwicap_clb_lut.h files Removed
xhwicap_lut.c and xhwicap_ff.c examples Removed defines XHI_FAR_MAJOR_FRAME_MASK
XHI_FAR_MINOR_FRAME_MASK XHI_FAR_MAJOR_FRAME_SHIFT XHI_FAR_MINOR_FRAME_SHIFT
XHI_C0R_1 Updated XHI_FAR_COLUMN_ADDR_MASK to 0x3FF Updated XHI_FAR_BLOCK_SHIFT
to 23 Updated XHI_FAR_TOP_BOTTOM_SHIFT to 22 Updated XHI_FAR_ROW_ADDR_SHIFT to
17 Updated XHI_NUM_FRAME_BYTES to 404 Updated XHI_NUM_FRAME_WORDS to 101 Updated
XHI_NUM_WORDS_FRAME_INCL_NULL_FRAME to 202 CR 909615. 10.2 mi 09/22/16 Fixed
compilation warnings. 11.0 ms 01/23/17 Added xil_printf statement in main
function for all examples to ensure that "Successfully ran" and "Failed" strings
are available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. 11.2 Nava 02/08/19
The current version of the driver is not supported for families older than 7
series.So removed .o referenced function prototypes from the header file. </pre>

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_device_read_frame.c
@addtogroup hwicap_v11_2 @{ This file contains the function that reads a
specified frame from the device (ICAP) and stores it in the memory specified by
the user. @note none. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a bjb 11/20/03 First release 1.01a nps 04/10/06 V4 Support
2.00a ecm 10/20/07 V5 Support 4.00a hvm 11/30/09 Added support for V6 and
updated with HAL phase 1 modifications 5.00a hvm 2/25/10 Added support for S6
6.00a hvm 08/01/11 Added support for K7 10.0 bss 6/24/14 Removed support for
families older than 7 series 11.0 MNK 6/12/14 Added support for 8-series family
devices. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_device_read_frame.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_device_write_frame.c
@addtogroup hwicap_v11_2 @{ This file contains the function that writes the
frame stored in the memory to the device (ICAP). @note none. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a bjb 11/20/03 First
release 1.01a bjb 04/10/06 V4 Support 4.00a hvm 11/30/09 Added support for V6
and updated with HAL phase 1 modifications 5.00a hvm 2/25/10 Added support for
S6 5.01a hvm 07/06/10 Removed the code that adds wrong data byte before the CRC
bytes in the XHwIcap_DeviceWriteFrame function for S6 (CR560534) 6.00a hvm
08/01/11 Added support for K7 10.0 bss 6/24/14 Removed support for families
older than 7 series </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_device_write_frame.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_g.c @addtogroup
hwicap_v11_2 @{ This file contains a configuration table that specifies the
configuration of Hwicap devices in the system. Each device in the system should
have an entry in the table. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a bjb 12/08/03 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_i.h @addtogroup
hwicap_v11_2 @{ This head file contains internal identifiers, which are those
shared between the files of the driver. It is intended for internal use only.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a bjb
11/14/03 First release 1.00b nps 02/09/05 V4 changes 1.01a tjb 10/14/05 V4
Updates 2.00a sv 10/14/07 V5 Updates 3.01a sv 10/19/09 Corrected the V5 BOOTSTS
and CTL_1 Register definitions as they were wrongly defined 4.00a hvm 11/13/09
Updated with V6 changes 5.00a hvm 2/25/10 Added changes to support S6 6.00a hvm
08/01/11 Added support for K7 7.00a bss 03/14/12 Added Virtex 7, Artix 7 and
Zynq Device families 8.01a bss 05/14/12 Added the define XHI_COR_1 for CR718042
9.0 bss 02/20/14 Added XHI_DEV_FAMILY_K8 for Kintex 8 devices. CR764668 10.0 bss
6/24/14 Removed support for families older than 7 series. Removed IDCODE macros.
10.1 nsk 01/06/15 Removed defines XHI_FAR_MAJOR_FRAME_MASK
XHI_FAR_MINOR_FRAME_MASK XHI_FAR_MAJOR_FRAME_SHIFT XHI_FAR_MINOR_FRAME_SHIFT
XHI_C0R_1 Updated XHI_FAR_COLUMN_ADDR_MASK to 0x3FF Updated XHI_FAR_BLOCK_SHIFT
to 23 Updated XHI_FAR_TOP_BOTTOM_SHIFT to 22 Updated XHI_FAR_ROW_ADDR_SHIFT to
17 Updated XHI_NUM_FRAME_BYTES to 404 Updated XHI_NUM_FRAME_WORDS to 101 Updated
XHI_NUM_WORDS_FRAME_INCL_NULL_FRAME to 202 </pre>

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_intr.c @addtogroup
hwicap_v11_2 @{ This file contains interrupt handling API functions of the
HwIcap device. Refer to xhwicap.h header file and device specification for more
information. @note Calling the interrupt functions without including the
interrupt component will result in asserts if asserts are enabled, and will
result in a unpredictable behavior if the asserts are not enabled. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 2.00a sv
09/22/07 First release 4.00a hvm 12/1/09 Updated with HAL phase 1 changes </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_l.h @addtogroup
hwicap_v11_2 @{ This header file contains identifiers and basic driver functions
(or macros) that can be used to access the device. Other driver functions are
defined in xhwicap.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 2.00a sv 09/28/07 First release for the FIFO mode 3.00a sv
11/28/08 Added Abort bit definition in the Control Register Removed
XHI_WFO_MAX_VACANCY and XHI_RFO_MAX_OCCUPANCY definitions. 3.01a sv 10/21/09
Corrected the IDCODE definitions for some of the V5 FX parts. 4.00a hvm 11/30/09
Added support for V6 and updated with HAL phase 1 modifications 5.00a hvm
02/04/10 Added S6 Support 5.03a hvm 15/4/11 Updated with V6 CXT device
definitions. 6.00a hvm 08/01/11 Updated with K7 device Ids. 7.00a bss 03/14/12
Added EOS mask and Hang mask CR CR 637538 Added Virtex 7 and Zynq Idcodes - CR
647140, CR 643295 8.00a bss 06/20/12 Deleted Hang mask definition as per CR
656162 9.0 bss 02/20/14 Added Kintex 8 and Virtex72000T device Idcodes. 10.0 bss
6/24/14 Removed support for families older than 7 series </pre>

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_selftest.c @addtogroup
hwicap_v11_2 @{ This file contains a diagnostic self test function for the
XHwIcap driver. The self test functions writes to the Interrupt Enable Register
and reads it back for comparison. See xhwicap.h for more information. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- --------
1.00a sv 09/17/07 First release 4.00a hvm 12/1/09 Updated with HAL phase 1
modifications </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_sinit.c @addtogroup
hwicap_v11_2 @{ This file contains the implementation of the XHwicap driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 2.00a sv 09/28/07 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhwicap_srp.c @addtogroup
hwicap_v11_2 @{ This file contains the functions of the XHwIcap driver used to
access the configuration memory of the Xilinx FPGAs through the ICAP port. These
APIs provide methods for reading and writing data, frames, and partial
bitstreams to the ICAP port. See xhwicap.h for a detailed description of the
driver. @note Only 7 series, Zynq, Ultrascale and ZynqMP Ultrascale devices are
supported. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a bjb 11/17/03 First release 1.01a sv 03/03/07 V4 Updates. 2.00a ecm
10/20/07 V5 Support 4.00a hvm 11/30/09 Added support for V6 and updated with HAL
phase 1 modifications 5.00a hvm 2/25/10 Added support for S6 5.00a hvm 5/21/10
Modified XHwIcap_GetConfigReg function for V4/V5/V6/S6 command sequence. Added
one extra NOP before the Type 1 read config register command and removed an
extra NOP after the config register command. 6.00a hvm 8/12/11 Added support for
K7 7.00a bss 03/14/12 ReadId API is added to desync after lock up during
configuration CR 637538 8.00a bss 06/20/12 Deleted ReadId API as per CR 656162
10.0 bss 6/24/14 Removed support for families older than 7 series </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/hwicap/src/xhwicap_srp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl - - - - - - - - - - - - - - - - - - -- - - - -
- - - - - - - - - - - - - - Software Project Types (swproj): 0 : MemoryTest -
Calls basic memorytest routines from common driver dir 1 : PeripheralTest -
Calls any existing polled_example and/or selftest - - - - - - - - - - - - - - -
- - - -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - TCL Procedures: - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -

FILES:
XilinxProcessorIPLib/drivers/i2srx/data/i2srx_tapp.tcl
XilinxProcessorIPLib/drivers/i2stx/data/i2stx_tapp.tcl
XilinxProcessorIPLib/drivers/sdiaud/data/sdiaud_tapp.tcl
XilinxProcessorIPLib/drivers/spdif/data/spdif_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"),to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_header.h @addtogroup
i2srx_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 First release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/i2srx/data/xi2srx_header.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"),to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_intr_example.c This
file contains a example for using the I2S receiver hardware device and I2S
receiver driver using interrupt mode.This example assumes that the interrupt
controller is also present as a part of the system. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- --- -------- 1.0 kar 01/25/18 First release </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/examples/xi2srx_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_selftest_example.c
This file contains a example for using the I2S receiver hardware device and I2S
receiver driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---
-------- 1.0 kar 01/25/18 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/examples/xi2srx_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx.c @addtogroup
i2srx_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. 1.1 kar 04/02/18 Changed Channel
Status clear API to clear all regs. 2.0 kar 09/28/18 Added new API to enable
justification. Added new API to select left/right justification. </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx.h @addtogroup
i2srx_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. 1.1 kar 04/02/18 Added debug log
function prototypes. 2.0 kar 09/28/18 Added new API to enable justification.
Added new API to select left/right justification. </pre> /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_chsts.c @addtogroup
i2srx_v1_0 @{ This file implements the channel status format related functions.
For formats/line protocols check the AES standard specifications document. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kar
01/25/18 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_chsts.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_chsts.h @addtogroup
i2srx_v1_0 @{ Format status related offsets & masks definitions related to the
channel status format.For formats/line protocols check the AES standard
specifications document <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 kar 01/25/18 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_chsts.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_debug.c @addtogroup
i2srx_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. 1.1 kar 04/02/18 Changed log APIs to
take i2srx instance as argument. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_debug.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_debug.h @addtogroup
i2srx_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. 1.1 kar 04/02/18 Moved debug Function
prototypes to xi2srx.h file </pre> /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xi2srx_hw.h @addtogroup
i2srx_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. 2.0 kar 09/28/18 Added justication
enable masks and shifts. Added left and right justification masks and shifts.
</pre>

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_intr.c @addtogroup
i2srx_v1_0 @{ ... <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
---------- 1.0 kar 01/25/18 Initial release. 1.1 kar 04/02/18 Changed log write
API's argument to i2srx instance. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_selftest.c @addtogroup
i2srx_v1_0 @{ Contains an basic self-test API that displays the version of the
I2S Receiver device. Additionally, it also verifies and displays the
configuration of the drivers for i2s data width, if the Receiver core IsMaster,
and the maximum channels supported by the I2s device. @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- ---------- 1.0 kar
01/25/18 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2srx_sinit.c @addtogroup
i2srx_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2srx/src/xi2srx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, andor sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions: The above
copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FILES:
XilinxProcessorIPLib/drivers/i2stx/data/i2stx.mdd
XilinxProcessorIPLib/drivers/i2stx/data/i2stx.tcl
XilinxProcessorIPLib/drivers/sdiaud/data/sdiaud.tcl
XilinxProcessorIPLib/drivers/v_hdmirxss/data/v_hdmirxss.mdd
XilinxProcessorIPLib/drivers/v_hdmitxss/data/v_hdmitxss.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_header.h @addtogroup
i2stx_v1_0 @{ <pre> MODIFICATION HISTORY:i Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 First release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/i2stx/data/xi2stx_header.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_intr_example.c This
file contains a example for using the I2s Transmitter hardware device and I2s
Transmitter driver using interrupt mode.This example assumes that the interrupt
controller is also present as a part of the system. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- --- -------- 1.0 kar 01/25/18 First release </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/examples/xi2stx_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xi2stx_selftest_example.c This
file contains a example for using the I2s Transmitter hardware device and I2s
Transmitter driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.0 kar 01/25/18 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/examples/xi2stx_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx.c @addtogroup
i2stx_v1_1 @{ Contains a minimal set of functions for the i2s_transmitter driver
that allow access to all of the i2s transmitter core's functionality. See
xi2stx.h for a detailed description of the driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kar
11/16/17 Initial release. 1.1 kar 04/02/18 Changed channel status clear API to
clear all regs. 2.0 kar 09/28/18 Added new API to enable justification. Added
new API to select left/right justification. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx.h @addtogroup
i2stx_v1_1 @{ The Xilinx I2s Transmitter driver. This driver supports the Xilinx
I2s Transmitter soft IP core in transmit/source (TX) operation. The Xilinx I2s
Transmitter core supports the following features: - 16 and 24 bit data widths. -
1,2,3 and 4 channels. - I2S timer control. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kar 11/16/17 Initial
release. 1.1 kar 04/02/18 Added debug log function prototypes. 2.0 kar 09/28/18
Added new API to enable justification. Added new API to select left/right
justification. </pre> /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_chsts.c @addtogroup
i2stx_v1_0 @{ This file implements the channel status format related
functions.For formats/line protocols check the AES Standard specifications
document. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 kar 11/16/17 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_chsts.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_chsts.h @addtogroup
i2stx_1_0 @{ Format status related offsets & masks definitions related to the
channel status format. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 kar 11/16/17 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_chsts.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_debug.c @addtogroup
i2stx_v1_1 @{ This file contains functions to debug i2s_transmitter driver, and
log the I2S Transmitter transactions in a buffer. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kar 11/16/17 Initial
release. 1.1 kar 04/02/18 Changed log API's to take i2stx instance as argument.
</pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_debug.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_debug.h @addtogroup
i2stx_v1_1 @{ This file contains defintions of data structures used in debugging
and logging the I2S Transmitter transactions. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kar 11/16/17 Initial
release. 1.1 kar 04/02/18 Moved debug function prototypes to xi2stx.h file.
</pre> /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_hw.h @addtogroup
i2stx_v1_0 @{ Hardware register & masks definition file. It defines the register
interface. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 11/16/17 Initial release. 2.0 kar 09/28/18 Added justication
enable masks and shifts. Added left and right justification masks and shifts.
</pre> /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_intr.c @addtogroup
i2stx_v1_1 @{ This file contains functions related to i2s_transmitter interrupt
handling. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
----- ---------- 1.0 kar 11/16/17 Initial release. 1.1 kar 04/02/18 Changed log
write API's argument to i2stx instance. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_selftest.c @addtogroup
i2stx_v1_0 @{ Contains an basic sef-test API that displays the version of the
I2S Transmitter device. Additionally, it also verifies and displays the
configuration of the drivers for i2s data width, if the transmitter core
IsMaster, and the maximum channels supported by the I2S device. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 kar
11/16/17 Initial release. 2.0 kar 10/01/18 included xil_types and xil_assert
header files. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xi2stx_sinit.c @addtogroup
i2stx_v1_0 @{ This file contains static initialization methods for the i2stx
drivers. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 kar 11/16/17 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/i2stx/src/xi2stx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Removed support for xps_iic
@BEGIN_CHANGELOG EDK_M - Removed support for opb_iic @END_CHANGELOG
@BEGIN_CHANGELOG EDK_MS3 06/16/10 sv Added support for axi_iic @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/iic/data/iic.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_M Removed the local
::hsi::utils::define_canonical_xpars API as there is a common API in the tcl of
the tools @END_CHANGELOG @BEGIN_CHANGELOG EDK_LS3 Updated to handle the corner
cases described in CR 518193 while generating canonical definitions
@END_CHANGELOG uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/iic/data/iic.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_I - include header files @END_CHANGELOG
@BEGIN_CHANGELOG EDK_H - Added support for generation of multiple applications.
All TCL procedures are now required to have a software project type as its first
argument @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/iic/data/iic_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_dynamic_eeprom_example.c
This file consists of a Interrupt mode design example which uses the Xilinx IIC
device and XIic driver to exercise the EEPROM in Dynamic controller mode. The
XIic driver uses the complete FIFO functionality to transmit/receive data. This
example writes/reads from the lower 256 bytes of the IIC EEPROMS. Please refer
to the datasheets of the IIC EEPROM's for details about the internal addressing
and page size of these devices. The XIic_DynMasterSend() API is used to transmit
the data and XIic_DynMasterRecv() API is used to receive the data. This example
is tested on ML300/ML310/ML403/ML501/ML507/ML510/ML605/SP601 and SP605 Xilinx
boards. The ML310/ML410/ML510 boards have a on-board 64 Kb serial IIC EEPROM
(Microchip 24LC64A). The WP pin of the IIC EEPROM is hardwired to ground on this
board. The ML300 board has an on-board 32 Kb serial IIC EEPROM(Microchip
24LC32A). The WP pin of the IIC EEPROM has to be connected to ground for this
example. The WP is connected to pin Y3 of the FPGA. The ML403 board has an on-
board 4 Kb serial IIC EEPROM(Microchip 24LC04A). The WP pin of the IIC EEPROM is
hardwired to ground on this board. The ML501/ML505/ML507/ML605/SP601/SP605
boards have an on-board 8 Kb serial IIC EEPROM(STM M24C08). The WP pin of the
IIC EEPROM is hardwired to ground on these boards. The AddressType for
ML300/ML310/ML410/ML510 boards should be u16 as the address pointer in the on
board EEPROM is 2 bytes. The AddressType for
ML403/ML501/ML505/ML507/ML605/SP601/SP605 boards should be u8 as the address
pointer for the on board EEPROM is 1 byte. The 7 bit IIC Slave address of the
IIC EEPROM on the ML300/ML310/ML403/ML410/ ML501/ML505/ML507/ML510 boards is
0x50. The 7 bit IIC Slave address of the IIC EEPROM on the ML605/SP601/SP605
boards is 0x54. Refer to the User Guide's of the respective boards for further
information about the IIC slave address of IIC EEPROM's. The define
EEPROM_ADDRESS in this file needs to be changed depending on the board on which
this example is to be run. This code assumes that no Operating System is being
used. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a mta 04/13/06 Created. 2.00a ktn 11/17/09 Updated to use the HAL
APIs. 2.01a ktn 03/17/10 Updated the information about the EEPROM's used on
ML605/SP601/SP605 boards. Updated the example so that it can be used to access
the entire IIC EEPROM for devices like M24C04/M24C08 that use LSB bits of the
IIC device select code (IIC slave address) to specify the higher address bits of
the EEPROM internal address. 3.4 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_dynamic_eeprom_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_eeprom_example.c This file
consists of a Interrupt mode design example which uses the Xilinx IIC device and
XIic driver to exercise the EEPROM. The XIic driver uses the complete FIFO
functionality to transmit/receive data. This example writes/reads from the lower
256 bytes of the IIC EEPROMS. Please refer to the datasheets of the IIC EEPROM's
for details about the internal addressing and page size of these devices. The
XIic_MasterSend() API is used to transmit the data and XIic_MasterRecv() API is
used to receive the data. This example is tested on
ML300/ML310/ML410/ML403/ML501/ML507/ML510/ML605/ SP601, SP605, KC705 , ZC702 and
ZC706 Xilinx boards. The ML310/ML510/ML410 boards have a on-board 64 Kb serial
IIC EEPROM (Microchip 24LC64A). The WP pin of the IIC EEPROM is hardwired to
ground on this board. The ML300 board has an on-board 32 Kb serial IIC
EEPROM(Microchip 24LC32A). The WP pin of the IIC EEPROM has to be connected to
ground for this example. The WP is connected to pin Y3 of the FPGA. The ML403
board has an on-board 4 Kb serial IIC EEPROM(Microchip 24LC04A). The WP pin of
the IIC EEPROM is hardwired to ground on this board. The
ML501/ML505/ML507/ML605/SP601/SP605/KC705/ZC702/ZC706 boards have an on-board 8
Kb serial IIC EEPROM(STM M24C08). The WP pin of the IIC EEPROM is hardwired to
ground on these boards. The AddressType for ML300/ML310/ML410/ML510 boards
should be u16 as the address pointer in the on board EEPROM is 2 bytes. The
AddressType for ML403/ML501/ML505/ML507/ML605/SP601/SP605/KC705/ZC702/ ZC706
boards should be u8 as the address pointer for the on board EEPROM is 1 byte.
The 7 bit IIC Slave address of the IIC EEPROM on the ML300/ML310/ML403/ML410/
ML501/ML505/ML507/ML510 boards is 0x50. The 7 bit IIC Slave address of the IIC
EEPROM on the ML605/SP601/SP605/KC705 /ZC702/ZC706 boards is 0x54. Refer to the
User Guide's of the respective boards for further information about the IIC
slave address of IIC EEPROM's. The define EEPROM_ADDRESS in this file needs to
be changed depending on the board on which this example is to be run. This is
the IIC address of the EEPROM. The define IIC_MUX_ADDRESS in this file needs to
be changed depending on the board on which this example is to be run. This is
the IIC address of the the MUX. The define IIC_MUX_ENABLE should be defined so
that the IIC Mux initialization is done for the boards on the which the EEPROM
is connected to an IIC Mux. The boards with a MUX are a KC705/ZC702/ZC706. The
define IIC_EEPROM_CHANNEL needs to be changed depending on the Channel number of
EEPROM for IIC Mux. On KC705 it is 0x08 and ZC702 is 0x04. Please refer the User
Guide's of the respective boards for further information about the Channel
number to use EEPROM. This code assumes that no Operating System is being used.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a mta 02/24/06 Created. 1.00a mta 04/05/07 Added support for microblaze.
2.00a ktn 11/17/09 Updated to use the HAL APIs and replaced call to
XIic_Initialize API with XIic_LookupConfig and XIic_CfgInitialize. 2.01a ktn
03/17/10 Updated the information about the EEPROM's used on ML605/SP601/SP605
boards. Updated the example so that it can be used to access the entire IIC
EEPROM for devices like M24C04/M24C08 that use LSB bits of the IIC device select
code (IIC slave address) to specify the higher address bits of the EEPROM
internal address. 2.02a bss 01/30/13 Updated for using the GIC in case of Zynq
2.06a bss 02/14/13 Added MuxInit API to support Zynq and KC705 boards and
modified to use ScuGic in case of Zynq CR 683509 3.4 ms 01/23/17 Added
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_eeprom_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xiic_low_level_dynamic_eeprom_example.c This file consists of a polled mode
design example which uses the Xilinx IIC device in dynamic mode and low-level
driver to exercise the EEPROM. The XIic_DynSend() API is used to transmit the
data and XIic_DynRecv() API is used to receive the data. The example is tested
on ML300/ML310/ML403/ML501/ML507/ML510 Xilinx boards. The ML310/ML410/ML510
boards have a on-board 64 Kb serial IIC EEPROM (Microchip 24LC64A). The WP pin
of the IIC EEPROM is hardwired to ground on this board. The ML300 board has an
on-board 32 Kb serial IIC EEPROM(Microchip 24LC32A). The WP pin of the IIC
EEPROM has to be connected to ground for this example. The WP is connected to
pin Y3 of the FPGA. The ML403 board has an on-board 4 Kb serial IIC
EEPROM(Microchip 24LC04A). The WP pin of the IIC EEPROM is hardwired to ground
on this board. The ML501/ML505/ML507/ML605/SP601/SP605 boards have an on-board 8
Kb serial IIC EEPROM(STM M24C08). The WP pin of the IIC EEPROM is hardwired to
ground on these boards. The AddressType for ML300/ML310/ML410/ML510 boards
should be u16 as the address pointer in the on board EEPROM is 2 bytes. The
AddressType for ML403/ML501/ML505/ML507/ML605/SP601/SP605 boards should be u8 as
the address pointer for the on board EEPROM is 1 byte. The 7 bit IIC Slave
address of the IIC EEPROM on the ML300/ML310/ML410/ML403/
ML501/ML505/ML507/ML510 boards is 0x50. The 7 bit IIC Slave address of the IIC
EEPROM on the ML605/SP601/SP605 boards is 0x54. Refer to the User Guide's of the
respective boards for further information about the IIC slave address of IIC
EEPROM's. The define EEPROM_ADDRESS in this file needs to be changed depending
on the board on which this example is to be run. This code assumes that no
Operating System is being used. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a mta 03/20/06 Created. 2.00a sdm 09/22/09
Converted all register accesses to 32 bit access. 2.01a ktn 03/17/10 Updated the
information about the EEPROM's used on ML605/SP601/SP605 boards. Updated the
example so that it can be used to access the entire IIC EEPROM for devices like
M24C04/M24C08 that use LSB bits of the IIC device select code (IIC slave
address) to specify the higher address bits of the EEPROM internal address. 3.3
sk 06/18/16 checked bytes written with the input byte count and returns error if
the value is not matched. 3.4 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_low_level_dynamic_eeprom_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_low_level_eeprom_example.c
This file consists of a polled mode design example which uses the Xilinx IIC
device and low-level driver to exercise the EEPROM. This example writes/reads
from the lower 256 bytes of the IIC EEPROMS. Please refer to the datasheets of
the IIC EEPROM's for details about the internal addressing and page size of
these devices. The XIic_Send() API is used to transmit the data and XIic_Recv()
API is used to receive the data. This example is tested on
ML300/ML310/ML403/ML501/ML507/ML510/ML605/SP601 and SP605 Xilinx boards. The
ML310/ML410/ML510 boards have a on-board 64 Kb serial IIC EEPROM (Microchip
24LC64A). The WP pin of the IIC EEPROM is hardwired to ground on this board. The
ML300 board has an on-board 32 Kb serial IIC EEPROM(Microchip 24LC32A). The WP
pin of the IIC EEPROM has to be connected to ground for this example. The WP is
connected to pin Y3 of the FPGA. The ML403 board has an on-board 4 Kb serial IIC
EEPROM(Microchip 24LC04A). The WP pin of the IIC EEPROM is hardwired to ground
on this board. The ML501/ML505/ML507/ML605/SP601/SP605 boards have an on-board 8
Kb serial IIC EEPROM(STM M24C08). The WP pin of the IIC EEPROM is hardwired to
ground on these boards. The AddressType for ML300/ML310/ML410/ML510 boards
should be u16 as the address pointer in the on board EEPROM is 2 bytes. The
AddressType for ML403/ML501/ML505/ML507/ML605/SP601/SP605 boards should be u8 as
the address pointer for the on board EEPROM is 1 byte. The 7 bit IIC Slave
address of the IIC EEPROM on the ML300/ML310/ML403/ML410/
ML501/ML505/ML507/ML510 boards is 0x50. The 7 bit IIC Slave address of the IIC
EEPROM on the ML605/SP601/SP605 boards is 0x54. Refer to the User Guide's of the
respective boards for further information about the IIC slave address of IIC
EEPROM's. The define EEPROM_ADDRESS in this file needs to be changed depending
on the board on which this example is to be run. This code assumes that no
Operating System is being used. @note None <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a jhl 09/10/03 Created 1.00a sv 05/09/05
Minor changes to comply to Doxygen and coding guidelines 1.00a mta 03/09/06
Minor updates due to changes in the low level driver for supporting repeated
start functionality. 2.00a sdm 09/22/09 Converted all register accesses to 32
bit access and minor modifications as per coding guidelines. 2.01a ktn 03/17/10
Updated the information about the EEPROM's used on ML605/SP601/SP605 boards.
Updated the example so that it can be used to access the entire IIC EEPROM for
devices like M24C04/M24C08 that use LSB bits of the IIC device select code (IIC
slave address) to specify the higher address bits of the EEPROM internal
address. 2.01a sdm 06/13/11 Updated the example to flush the Tx FIFO when
waiting for the previous command to be completed for CR612546. 3.4 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
3.5 sd 08/29/18 Update the fifo flush. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_low_level_eeprom_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xiic_low_level_tempsensor_example.c This file contains a polled mode design
example which uses the Xilinx IIC device and low-level driver to execise the
temperature sensor on the ML300 board. This example only performs read
operations (receive) from the IIC temperature sensor of the platform. The
XIic_Recv() API is used to receive the data. @note 7-bit addressing is used to
access the tempsensor. None <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jhl 10/09/03 Initial Release 1.00a sv 05/09/05 Minor
changes to comply to Doxygen and coding guidelines 1.00a mta 03/09/06 Minor
updates due to changes in the low level driver for supporting repeated start
functionality. 2.00a sdm 09/22/09 Minor modifications as per coding guidelines.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_low_level_tempsensor_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_multi_master_example.c
This file consists of a Interrupt mode design example which uses the Xilinx IIC
device and XIic driver to exercise the EEPROM on the Xilinx boards in a Multi
master mode. This example has been tested with an off-board external IIC Master
connected on the IIC bus. This example writes/reads from the lower 256 bytes of
the IIC EEPROMS. Please refer to the datasheets of the IIC EEPROM's for details
about the internal addressing and page size of these devices. The
XIic_MasterSend() API is used to transmit the data and XIic_MasterRecv() API is
used to receive the data. The example is tested on ML300/ML310/ML403/ML501
Xilinx boards. The ML310/ML410/ML510 boards have a on-board 64 Kb serial IIC
EEPROM (Microchip 24LC64A). The WP pin of the IIC EEPROM is hardwired to ground
on this board. The ML300 board has an on-board 32 Kb serial IIC EEPROM(Microchip
24LC32A). The WP pin of the IIC EEPROM has to be connected to ground for this
example. The WP is connected to pin Y3 of the FPGA. The ML403 board has an on-
board 4 Kb serial IIC EEPROM(Microchip 24LC04A). The WP pin of the IIC EEPROM is
hardwired to ground on this board. The ML501/ML505/ML507/ML605/SP601/SP605
boards have an on-board 8 Kb serial IIC EEPROM(STM M24C08). The WP pin of the
IIC EEPROM is hardwired to ground on these boards. The AddressType for
ML300/ML310/ML410/ML510 boards should be u16 as the address pointer in the on
board EEPROM is 2 bytes. The AddressType for
ML403/ML501/ML505/ML507/ML605/SP601/SP605 boards should be u8 as the address
pointer for the on board EEPROM is 1 byte. The 7 bit IIC Slave address of the
IIC EEPROM on the ML300/ML310/ML403/ML410/ ML501/ML505/ML507/ML510 boards is
0x50. The 7 bit IIC Slave address of the IIC EEPROM on the ML605/SP601/SP605
boards is 0x54. Refer to the User Guide's of the respective boards for further
information about the IIC slave address of IIC EEPROM's. The define
EEPROM_ADDRESS in this file needs to be changed depending on the board on which
this example is to be run. This code assumes that no Operating System is being
used. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a mta 03/01/06 Created. 2.00a sdm 09/22/09 Converted all register
accesses to 32 bit access. Updated to use the HAL APIs, replaced call to
XIic_Initialize API with XIic_LookupConfig and XIic_CfgInitialize. 2.01a ktn
03/17/10 Updated the information about the EEPROM's used on ML605/SP601/SP605
boards. 3.4 ms 01/23/17 Added xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_multi_master_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_repeated_start_example.c
This file consists of a interrupt mode design example to demonstrate the use of
repeated start using the XIic driver. The XIic_MasterSend() API is used to
transmit the data and XIic_MasterRecv() API is used to receive the data. The IIC
devices that are present on the Xilinx boards donot support the repeated start
option. These examples have been tested with an IIC device external to the
boards. This code assumes that no Operating System is being used. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a mta
02/20/06 Created. 2.00a sdm 09/22/09 Updated to use the HAL APIs, replaced call
to XIic_Initialize API with XIic_LookupConfig and XIic_CfgInitialize. Updated
the example with a fix for CR539763 where XIic_Start was being called instead of
XIic_Stop. Added code for setting up the StatusHandler callback. 3.4 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_repeated_start_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_selftest_example.c This
file contains a example for using the IIC hardware device and XIic driver. @note
None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
sv 05/09/05 Initial release for TestApp integration. 2.00a sdm 09/22/09 Updated
to use the HAL APIs, replaced call to XIic_Initialize API with XIic_LookupConfig
and XIic_CfgInitialize. Minor changes made as per coding guidelines. 3.4 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre>

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_slave_example.c This file
consists of a Interrupt mode design example which uses the Xilinx IIC device and
XIic driver to exercise the slave functionality of the IIC device. The
XIic_SlaveSend() API is used to transmit the data and XIic_SlaveRecv() API is
used to receive the data. The example is tested on ML300/ML310/ML403/ML501
Xilinx boards. The IIC devices that are present on the Xilinx boards donot
support the Master functionality. This example has been tested with an off board
external IIC Master device and the IIC device configured as a Slave. This code
assumes that no Operating System is being used. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a mta 03/01/06 Created.
2.00a ktn 11/17/09 Updated to use the HAL APIs and replaced call to
XIic_Initialize API with XIic_LookupConfig and XIic_CfgInitialize. Some of the
macros have been renamed in the IIC driver and some renamed macros are used in
this example. 3.4 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_slave_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_tempsensor_example.c This
file contains an interrupt based design example which uses the Xilinx IIC device
and driver to exercise the temperature sensor on the ML300 board. This example
only performs read operations (receive) from the IIC temperature sensor of the
platform. The XIic_MasterRecv() API is used to receive the data. This example
assumes that there is an interrupt controller in the hardware system and the IIC
device is connected to the interrupt controller. @note 7-bit addressing is used
to access the tempsensor. None <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jhl 09/10/03 Created 1.00a sv 05/09/05 Minor changes
to comply to Doxygen and coding guidelines 3.4 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_tempsensor_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_tenbitaddr_example.c This
file consists of a Interrupt mode design example which uses the Xilinx IIC
device and XIic driver to exercise the 10-bit Address functionality of the IIC
device. The XIic_MasterSend() API is used to transmit the data and
XIic_MasterRecv() API is used to receive the data. The example is tested on
ML300/ML310/ML403/ML501 Xilinx boards. The IIC devices that are present on the
Xilinx boards donot support the 10-bit functionality. This example has been
tested with an off board external IIC Master device and the IIC device
configured as a Slave. This code assumes that no Operating System is being used.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a mta 03/01/06 Created. 2.00a ktn 11/17/09 Updated to use the HAL APIs and
replaced call to XIic_Initialize API with XIic_LookupConfig and
XIic_CfgInitialize. Made minor modifications as per coding guidelines. 3.4 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/examples/xiic_tenbitaddr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic.c @addtogroup iic_v3_4 @{
Contains required functions for the XIic component. See xiic.h for more
information on the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- ------- 1.01a rfp 10/19/01 release 1.01c ecm 12/05/02 new rev 1.01c
rmm 05/14/03 Fixed diab compiler warnings relating to asserts. 1.01d jhl
10/08/03 Added general purpose output feature 1.02a jvb 12/13/05 Added
CfgInitialize(), and made CfgInitialize() take a pointer to a config structure
instead of a device id. Moved Initialize() into xiic_sinit.c, and have
Initialize() call CfgInitialize() after it retrieved the config structure using
the device id. Removed include of xparameters.h along with any dependencies on
xparameters.h and the _g.c config table. 1.02a mta 03/09/06 Added a new function
XIic_IsIicBusy() which returns whether IIC Bus is Busy or Free. 1.13a wgr
03/22/07 Converted to new coding style. 1.15a ktn 02/17/09 Fixed
XIic_GetAddress() to return correct device address. 1.16a ktn 07/18/09 Updated
the notes in XIic_Reset function to clearly indicate that only the Interrupt
Registers are reset. 1.16a ktn 10/16/09 Updated the notes in the XIic_SelfTest()
API to mention that the complete IIC core is Reset on giving a software reset to
the IIC core. This issue is fixed in the latest version of the IIC core (some
previous versions of the core only reset the Interrupt Logic/Registers), please
see the Hw specification for further information. 2.00a ktn 10/22/09 Converted
all register accesses to 32 bit access. Some of the macros have been renamed to
remove _m from the name see the xiic_i.h and xiic_l.h file for further
information (Example XIic_mClearIntr is now XIic_ClearIntr). Some of the macros
have been renamed to be consistent, see the xiic_l.h file for further
information (Example XIIC_WRITE_IIER is renamed as XIic_WriteIier). The driver
has been updated to use the HAL APIs/macros. 2.07a adk 18/04/13 Updated the code
to avoid unused variable warnings when compiling with the -Wextra -Wall flags.
Changes done if files xiic.c and xiic_i.h. CR:705001. 3.2 sk 11/10/15 Used
UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototype of
XIic_CfgInitialize API. 3.3 als 06/27/16 XIic_IsIicBusy now static inline in
xiic.h. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic.h @addtogroup iic_v3_4 @{
@details XIic is the driver for an IIC master or slave device. In order to
reduce the memory requirements of the driver the driver is partitioned such that
there are optional parts of the driver. Slave, master, and multimaster features
are optional such that all these files are not required at the same time. In
order to use the slave and multimaster features of the driver, the user must
call functions (XIic_SlaveInclude and XIic_MultiMasterInclude) to dynamically
include the code. These functions may be called at any time. Two sets of higher
level API's are available in the XIic driver that can be used for
Transmission/Reception in Master mode : - XIic_MasterSend()/ XIic_MasterRecv()
which is used in normal mode. - XIic_DynMasterSend()/ XIic_DynMasterRecv() which
is used in Dynamic mode. Similarly two sets of lower level API's are available
in XIic driver that can be used for Transmission/Reception in Master mode: -
XIic_Send()/ XIic_Recv() which is used in normal mode - XIic_DynSend()/
XIic_DynRecv() which is used in Dynamic mode. The user should use a single set
of APIs as per his requirement and should not intermix them. All the driver APIs
can be used for read, write and combined mode of operations on the IIC bus. In
the normal mode IIC support both 7-bit and 10-bit addressing, and in the dynamic
mode support only 7-bit addressing. <b>Initialization & Configuration</b> The
XIic_Config structure is used by the driver to configure itself. This
configuration structure is typically created by the tool-chain based on HW build
properties. To support multiple runtime loading and initialization strategies
employed by various operating systems, the driver instance can be initialized in
one of the following ways: - XIic_Initialize() - The driver looks up its own
configuration structure created by the tool-chain based on an ID provided by the
tool-chain. - XIic_CfgInitialize() - The driver uses a configuration structure
provided by the caller. If running in a system with address translation, the
provided virtual memory base address replaces the physical address present in
the configuration structure. <b>General Purpose Output</b> The IIC hardware
provides a General Purpose Output Register that allows the user to connect
general purpose outputs to devices, such as a write protect, for an EEPROM. This
register is parameterizable in the hardware such that there could be zero bits
in this register and in this case it will cause a bus error if read or written.
<b>Bus Throttling</b> The IIC hardware provides bus throttling which allows
either the device, as either a master or a slave, to stop the clock on the IIC
bus. This feature allows the software to perform the appropriate processing for
each interrupt without an unreasonable response restriction. With this design,
it is important for the user to understand the implications of bus throttling.
<b>Repeated Start</b> An application can send multiple messages, as a master, to
a slave device and re-acquire the IIC bus each time a message is sent. The
repeated start option allows the application to send multiple messages without
re-acquiring the IIC bus for each message. The transactions involving repeated
start are also called combined transfers if there is Read and Write in the same
transaction. The repeated start feature works with all the API's in XIic driver.
The Repeated Start feature also could cause the application to lock up, or
monopolize the IIC bus, should repeated start option be enabled and sequences of
messages never end(periodic data collection). Also when repeated start is not
disable before the last master message is sent or received, will leave the bus
captive to the master, but unused. <b>Addressing</b> The IIC hardware is
parameterized such that it can be built for 7 or 10 bit addresses. The driver
provides the ability to control which address size is sent in messages as a
master to a slave device. The address size which the hardware responds to as a
slave is parameterized as 7 or 10 bits but fixed by the hardware build.
Addresses are represented as hex values with no adjustment for the data
direction bit as the software manages address bit placement. This is especially
important as the bit placement is not handled the same depending on which
options are used such as repeated start and 7 vs 10 bit addressing. <b>Data
Rates</b> The IIC hardware is parameterized such that it can be built to support
data rates from DC to 400KBit. The frequency of the interrupts which occur is
proportional to the data rate. <b>Polled Mode Operation</b> This driver does not
provide a polled mode of operation primarily because polled mode which is non-
blocking is difficult with the amount of interaction with the hardware that is
necessary. <b>Interrupts</b> The device has many interrupts which allow IIC data
transactions as well as bus status processing to occur. The interrupts are
divided into two types, data and status. Data interrupts indicate data has been
received or transmitted while the status interrupts indicate the status of the
IIC bus. Some of the interrupts, such as Not Addressed As Slave and Bus Not
Busy, are only used when these specific events must be recognized as opposed to
being enabled at all times. Many of the interrupts are not a single event in
that they are continuously present such that they must be disabled after
recognition or when undesired. Some of these interrupts, which are data related,
may be acknowledged by the software by reading or writing data to the
appropriate register, or must be disabled. The following interrupts can be
continuous rather than single events. - Data Transmit Register Empty/Transmit
FIFO Empty - Data Receive Register Full/Receive FIFO - Transmit FIFO Half Empty
- Bus Not Busy - Addressed As Slave - Not Addressed As Slave The following
interrupts are not passed directly to the application through the status
callback. These are only used internally for the driver processing and may
result in the receive and send handlers being called to indicate completion of
an operation. The following interrupts are data related rather than status. -
Data Transmit Register Empty/Transmit FIFO Empty - Data Receive Register
Full/Receive FIFO - Transmit FIFO Half Empty - Slave Transmit Complete
<b>Interrupt To Event Mapping</b> The following table provides a mapping of the
interrupts to the events which are passed to the status handler and the intended
role (master or slave) for the event. Some interrupts can cause multiple events
which are combined together into a single status event such as
XII_MASTER_WRITE_EVENT and XII_GENERAL_CALL_EVENT <pre> Interrupt Event(s) Role
Arbitration Lost Interrupt XII_ARB_LOST_EVENT Master Transmit Error
XII_SLAVE_NO_ACK_EVENT Master IIC Bus Not Busy XII_BUS_NOT_BUSY_EVENT Master
Addressed As Slave XII_MASTER_READ_EVENT, Slave XII_MASTER_WRITE_EVENT, Slave
XII_GENERAL_CALL_EVENT Slave </pre> <b>Not Addressed As Slave Interrupt</b> The
Not Addressed As Slave interrupt is not passed directly to the application
through the status callback. It is used to determine the end of a message being
received by a slave when there was no stop condition (repeated start). It will
cause the receive handler to be called to indicate completion of the operation.
<b>RTOS Independence</b> This driver is intended to be RTOS and processor
independent. It works with physical addresses only. Any needs for dynamic memory
management, threads or thread mutual exclusion, virtual memory, or cache control
must be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.01a rfp 10/19/01 release 1.01c ecm
12/05/02 new rev 1.01d jhl 10/08/03 Added general purpose output feature 1.01d
sv 05/09/05 Changed the data being written to the Address/Control Register and
removed the code for testing the Receive Data Register in XIic_SelfTest function
of xiic_selftest.c source file 1.02a jvb 12/14/05 I separated dependency on the
static config table and xparameters.h from the driver initialization by moving
_Initialize and _LookupConfig to _sinit.c. I also added the new _CfgInitialize
routine. 1.02a mta 03/09/06 Added a new function XIic_IsIicBusy() which returns
whether IIC Bus is Busy or Free. 1.02a mta 03/09/06 Implemented Repeated Start
in the Low Level Driver. 1.03a mta 07/17/06 Added files to support Dynamic IIC
controller in High level driver. Added xiic_dyn_master.c. Added support for IIC
Dynamic controller in Low level driver in xiic_l.c 1.13a wgr 03/22/07 Converted
to new coding style. 1.13b ecm 11/29/07 added BB polling loops to the DynSend
and DynRecv routines to handle the race condition with BNB in IISR. 1.14a sdm
08/22/08 Removed support for static interrupt handlers from the MDD file 1.14a
ecm 11/13/08 changed BB polling loops in DynRecv to handle race condition,
CR491889. DynSend was correct from v1.13.b 1.15a ktn 02/17/09 Fixed
XIic_GetAddress() to return correct device address. 1.16a ktn 07/17/09 Updated
the XIic_SelfTest() to test only Interrupt Registers. 2.00a ktn 10/22/09
Converted all register accesses to 32 bit access., Removed the macro XIIC_RESET,
XIic_Reset API should be used in its place. Removed the XIIC_CLEAR_STATS macro,
XIic_ClearStats API should be used in its place. Removed the macro
XIic_mEnterCriticalRegion, XIic_IntrGlobalDisable should be used in its place.
Removed the macro XIic_mExitCriticalRegion, XIic_IntrGlobalEnable should be used
in its place. Some of the macros have been renamed to remove _m from the name
see the xiic_i.h and xiic_l.h file for further information (Example
XIic_mClearIntr is now XIic_ClearIntr). Some of the macros have been renamed to
be consistent, see the xiic_l.h file for further information (Example
XIIC_WRITE_IIER is renamed as XIic_WriteIier). The driver has been updated to
use the HAL APIs/macros (Example XASSERT_NONVOID is now Xil_AssertNonvoid) 2.01a
ktn 04/09/10 Updated TxErrorhandler in xiic_intr.c to be called for Master
Transmitter case based on Addressed As Slave (AAS) bit rather than MSMS bit(CR
540199). 2.02a sdm 10/08/10 Updated to disable the device at the end of the
transfer, using Addressed As Slave (AAS) bit when addressed as slave in
XIic_Send for CR565373. 2.03a rkv 01/25/11 Updated in NAAS interrupt handler to
support data received less than FIFO size prior to NAAS interrupt. Fixed for
CR590212. 2.04a sdm 07/22/11 Added IsSlaveSetAckOff flag to the instance
structure. This flag is set when the Slave has set the Ack Off in the
RecvSlaveData function (xiic_slave.c) and is cleared in the
NotAddrAsSlaveHandler (xiic_slave.c) when the master has released the bus. This
flag is to be used by slave applications for recovering when it has gone out of
sync with the master for CR 615004. Removed a compiler warning in XIic_Send
(xiic_l.c) 2.05a bss 02/05/12 Assigned RecvBufferPtr in XIic_MasterSend API and
SendBufferPtr in XIic_MasterRecv to NULL in xiic_master.c 2.06a bss 02/14/13
Modified TxErrorHandler in xiic_intr.c to fix CR 686483 Modified
xiic_eeprom_example.c to fix CR 683509. Modified bitwise OR to logical OR in
XIic_InterruptHandler API in xiic_intr.c. 2.07a adk 18/04/13 Updated the code to
avoid unused variable warnings when compiling with the -Wextra -Wall flags.
Changes done in files xiic.c and xiic_i.h. CR:705001 2.08a adk 29/07/13 In Low
level driver In repeated start condition the Direction of Tx bit must be
disabled in recv condition It Fixes the CR:685759 Changes are done in the file
xiic_l.c in the function XIic_Recv. 3.0 adk 19/12/13 Updated as per the New Tcl
API's 3.1 adk 01/08/15 When configured as a slave return the actual number of
bytes have been received/sent by the Master to the user callback (CR: 828504).
Changes are made in the file xiic_slave.c. 3.2 sk 11/10/15 Used UINTPTR instead
of u32 for Baseaddress CR 867425. Changed the prototype of XIic_CfgInitialize
API. 3.2 sd 18/02/16 In Low level driver in repeated start condition NACK for
last byte is added. Changes are done in XIic_Recv for CR 862303 3.3 sk 06/17/16
Added bus busy checks for slave send/recv and master send/recv. 3.3 als 06/27/16
XIic_IsIicBusy now a wrapper for XIic_CheckIsBusBusy. 3.4 ms 01/23/17 Added
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. ms 04/05/17 Modified Comment lines in functions of iic
examples to recognize it as documentation block for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_dyn_master.c @addtogroup
iic_v3_4 @{ Contains master functions for the XIic component in Dynamic
controller mode. This file is necessary to send or receive as a master on the
IIC bus. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------
1.03a mta 04/10/06 Created. 1.13a wgr 03/22/07 Converted to new coding style.
2.00a ktn 10/22/09 Converted all register accesses to 32 bit access. Updated to
use the HAL APIs/macros. The macros XIic_mDynSend7BitAddress and
XIic_mDynSendStop have been removed from this file as they were already defined
in a header file. Some of the macros have been renamed to remove _m from the
name and Some of the macros have been renamed to be consistent, see the xiic_l.h
file for further information. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_dyn_master.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_g.c @addtogroup iic_v3_4
@{ This file contains a configuration table that specifies the configuration of
IIC devices in the system. Each IIC device should have an entry in this table.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- ------- 1.01a rfp
10/19/01 release 1.01c ecm 12/05/02 new rev 1.01d jhl 10/08/03 Added general
purpose output feature 1.13a wgr 03/22/07 Converted to new coding style. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_i.h @addtogroup iic_v3_4
@{ This header file contains internal identifiers, which are those shared
between XIic components. The identifiers in this file are not intended for use
external to the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.01a rfp 10/19/01 release 1.01c ecm 12/05/02 new rev 1.13a wgr
03/22/07 Converted to new coding style. 2.00a sdm 10/22/09 Converted all
register accesses to 32 bit access. Removed the macro XIIC_CLEAR_STATS, user has
to use the the XIic_ClearStats API in its place. Removed the macro
XIic_mEnterCriticalRegion, XIic_IntrGlobalDisable should be used in its place.
Removed the macro XIic_mExitCriticalRegion, XIic_IntrGlobalEnable should be used
in its place. Removed the _m prefix from all the macros XIic_mSend10BitAddrByte1
is now XIic_Send10BitAddrByte1 XIic_mSend10BitAddrByte2 is now
XIic_Send10BitAddrByte2 XIic_mSend7BitAddr is now XIic_Send7BitAddr
XIic_mDisableIntr is now XIic_DisableIntr XIic_mEnableIntr is now
XIic_EnableIntr XIic_mClearIntr is now XIic_ClearIntr XIic_mClearEnableIntr is
now XIic_ClearEnableIntr XIic_mFlushRxFifo is now XIic_FlushRxFifo
XIic_mFlushTxFifo is now XIic_FlushTxFifo XIic_mReadRecvByte is now
XIic_ReadRecvByte XIic_mWriteSendByte is now XIic_WriteSendByte
XIic_mSetControlRegister is now XIic_SetControlRegister 2.07a adk 18/04/13
Updated the code to avoid unused variable warnings when compiling with the
-Wextra -Wall flags. Changes done in files xiic.c and xiic_i.h. CR:705001 </pre>

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_intr.c @addtogroup
iic_v3_4 @{ Contains interrupt functions of the XIic driver. This file is
required for the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.01a rfp 10/19/01 release 1.01c ecm 12/05/02 new rev 1.01c rmm
05/14/03 Fixed diab compiler warnings relating to asserts. 1.03a ecm 06/22/06
Added a call to the status handler in the TxErrorHandler even if the Rx buffer
pointer is not set. This fix is as a result of a Sony use model which did not
set the Rx pointer while in Master mode so it checks if MSMS 1. 1.13a wgr
03/22/07 Converted to new coding style. 2.00a sdm 10/22/09 Converted all
register accesses to 32 bit access. Updated to use the HAL APIs/macros. Some of
the macros have been renamed to remove _m from the name and Some of the macros
have been renamed to be consistent, see the xiic_l.h file for further
information. 2.01a ktn 04/09/10 Updated TxErrorhandler to be called for Master
Transmitter case based on Addressed As Slave (AAS) bit rather than MSMS bit(CR
540199). 2.06a bss 02/14/13 Modified TxErrorHandler in xiic_intr.c to fix CR
686483 Modified bitwise OR to logical OR in XIic_InterruptHandler API. 2.07a adk
18/04/13 Updated the code to avoid unused variable warnings when compiling with
the -Wextra -Wall flags. In the file xiic.c and xiic_i.h. CR:705001 </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_l.c @addtogroup iic_v3_4
@{ This file contains low-level driver functions that can be used to access the
device in normal and dynamic controller mode. The user should refer to the
hardware device specification for more details of the device operation. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- ------- 1.01b jhl 05/13/02
First release 1.01b jhl 10/14/02 Corrected bug in the receive function, the
setup of the interrupt status mask was not being done in the loop such that a
read would sometimes fail on the last byte because the transmit error which
should have been ignored was being used. This would leave an extra byte in the
FIFO and the bus throttled such that the next operation would also fail. Also
updated the receive function to not disable the device after the last byte until
after the bus transitions to not busy which is more consistent with the expected
behavior. 1.01c ecm 12/05/02 new rev 1.02a mta 03/09/06 Implemented Repeated
Start in the Low Level Driver. 1.03a mta 04/04/06 Implemented Dynamic IIC core
routines. 1.03a ecm 06/15/06 Fixed the hang in low_level_eeprom_test with -O0
Added polling loops for BNB to allow the slave to respond correctly. Also added
polling loop prior to reset in _Recv. 1.13a wgr 03/22/07 Converted to new coding
style. 1.13b ecm 11/29/07 added BB polling loops to the DynSend and DynRecv
routines to handle the race condition with BNB in IISR. 2.00a sdm 10/22/09
Converted all register accesses to 32 bit access. Updated to use the HAL
APIs/macros. Some of the macros have been renamed to remove _m from the name and
Some of the macros have been renamed to be consistent, see the xiic_i.h and
xiic_l.h files for further information. 2.02a sdm 10/08/10 Updated to disable
the device at the end of the transfer, only when addressed as slave in XIic_Send
for CR565373. 2.04a sdm 07/22/11 Removed a compiler warning by adding
parenthesis around & at line 479. 2.08a adk 29/07/13 In Low level driver In
repeated start condition the Direction of Tx bit must be disabled in Receive
condition It Fixes the CR:685759 Changes are done in the function XIic_Recv. 3.2
sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototypes of RecvData, SendData, DynRecvData, DynSendData APIs. 3.2 sd 18/02/16
In Low level driver in repeated start condition NACK for last byte is added.
Changes are done in XIic_Recv for CR 862303 3.3 sk 06/17/16 Added bus busy
checks for slave send/recv and master send/recv. 3.3 als 06/27/16 Added Low-
level XIic_CheckIsBusBusy API. 3.3 als 06/27/16 Added low-level XIic_WaitBusFree
API. 3.4 nk 16/11/16 Reduced sleeping time in Bus-busy check. 3.5 sd 08/29/18
Fix bus busy check for the NACK case. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_l.h @addtogroup iic_v3_4
@{ This header file contains identifiers and driver functions (or macros) that
can be used to access the device in normal and dynamic controller mode. High-
level driver functions are defined in xiic.h. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00b jhl 05/07/02 First release 1.01c ecm
12/05/02 new rev 1.01d jhl 10/08/03 Added general purpose output feature 1.02a
mta 03/09/06 Implemented Repeated Start in the Low Level Driver. 1.03a mta
04/04/06 Implemented Dynamic IIC core routines. 1.03a rpm 09/08/06 Added include
of xstatus.h for completeness 1.13a wgr 03/22/07 Converted to new coding style.
1.16a ktn 07/18/09 Updated the notes in XIIC_RESET macro to clearly indicate
that only the Interrupt Registers are reset. 1.16a ktn 10/16/09 Updated the
notes in the XIIC_RESET macro to mention that the complete IIC core is Reset on
giving a software reset to the IIC core. Some previous versions of the core only
reset the Interrupt Logic/Registers, please refer to the HW specification for
further details. 2.00a sdm 10/22/09 Converted all register accesses to 32 bit
access, the register offsets are defined to be on 32 bit boundary. Removed the
macro XIIC_RESET, XIic_Reset API should be used in its place. Some of the macros
have been renamed to be consistent XIIC_GINTR_DISABLE is renamed as
XIic_IntrGlobalDisable, XIIC_GINTR_ENABLE is renamed as XIic_IntrGlobalEnable,
XIIC_IS_GINTR_ENABLED is renamed as XIic_IsIntrGlobalEnabled, XIIC_WRITE_IISR is
renamed as XIic_WriteIisr, XIIC_READ_IISR is renamed as XIic_ReadIisr,
XIIC_WRITE_IIER is renamed as XIic_WriteIier The _m prefix in the name of the
macros has been removed XIic_mClearIisr is now XIic_ClearIisr,
XIic_mSend7BitAddress is now XIic_Send7BitAddress, XIic_mDynSend7BitAddress is
now XIic_DynSend7BitAddress, XIic_mDynSendStartStopAddress is now
XIic_DynSendStartStopAddress, XIic_mDynSendStop is now XIic_DynSendStop. 3.2 sk
11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototypes of XIic_Recv, XIic_Send, XIic_DynRecv, XIic_DynSend and XIic_DynInit
APIs. 3.3 als 06/27/16 Added Low-level XIic_CheckIsBusBusy API. 3.3 als 06/27/16
Added low-level XIic_WaitBusFree API. </pre>

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_master.c @addtogroup
iic_v3_4 @{ Contains master functions for the XIic component. This file is
necessary to send or receive as a master on the IIC bus. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- ------- 1.01b jhl 03/27/02 Reparitioned
the driver 1.01c ecm 12/05/02 new rev 1.13a wgr 03/22/07 Converted to new coding
style. 2.00a ktn 10/22/09 Converted all register accesses to 32 bit access.
Updated to use the HAL APIs/macros. Removed the macro XIic_mEnterCriticalRegion,
XIic_IntrGlobalDisable should be used in its place. Removed the macro
XIic_mExitCriticalRegion, XIic_IntrGlobalEnable should be used in its place.
Some of the macros have been renamed to remove _m from the name and some of the
macros have been renamed to be consistent, see the xiic_i.h and xiic_l.h files
for further information 2.05a bss 02/05/12 Assigned RecvBufferPtr in
XIic_MasterSend API and SendBufferPtr in XIic_MasterRecv NULL </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_master.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_multi_master.c @addtogroup
iic_v3_4 @{ Contains multi-master functions for the XIic component. This file is
necessary if multiple masters are on the IIC bus such that arbitration can be
lost or the bus can be busy. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- ------- 1.01b jhl 3/27/02 Reparitioned the driver 1.01c ecm 12/05/02
new rev 1.13a wgr 03/22/07 Converted to new coding style. 2.00a ktn 10/22/09
Converted all register accesses to 32 bit access. Updated to use the HAL
APIs/macros. Some of the macros have been renamed to remove _m from the name and
some of the macros have been renamed to be consistent, see the xiic_i.h and
xiic_l.h files for further information </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_multi_master.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_options.c @addtogroup
iic_v3_4 @{ Contains options functions for the XIic component. This file is not
required unless the functions in this file are called. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- ------- 1.01b jhl 3/26/02 repartioned
the driver 1.01c ecm 12/05/02 new rev 1.13a wgr 03/22/07 Converted to new coding
style. 2.00a ktn 10/22/09 Converted all register accesses to 32 bit access.
Updated to use the HAL APIs/macros. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_selftest.c @addtogroup
iic_v3_4 @{ Contains selftest functions for the XIic component. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- ------- 1.01b jhl 03/26/02
repartioned the driver 1.01c ecm 12/05/02 new rev 1.01c sv 05/09/05 Changed the
data being written to the Address/Control Register and removed the code for
testing the Receive Data Register. 1.13a wgr 03/22/07 Converted to new coding
style. 1.16a ktn 07/17/09 Updated the test to test only Interrupt Registers as
the software reset only resets the interrupt logic and the Interrupt Registers
are set to default values. 1.16a ktn 10/16/09 Updated the notes in the
XIic_SelfTest() API and XIIC_RESET macro to mention that the complete IIC core
is Reset on giving a software reset to the IIC core. Some previous versions of
the core only reset the Interrupt Logic/Registers, please refer to the HW
specification for further details. 2.00a ktn 10/22/09 Converted all register
accesses to 32 bit access. Updated to use the HAL APIs/macros. Some of the
macros have been renamed to remove _m from the name and some of the macros have
been renamed to be consistent, see the xiic_i.h and xiic_l.h files for further
information </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_sinit.c @addtogroup
iic_v3_4 @{ The implementation of the Xiic component's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
------- 1.02a jvb 10/13/05 release 1.13a wgr 03/22/07 Converted to new coding
style. 2.00a ktn 10/22/09 Converted all register accesses to 32 bit access.
Updated to use the HAL APIs/macros. Some of the macros have been renamed to
remove _m from the name and some of the macros have been renamed to be
consistent, see the xiic_i.h and xiic_l.h files for further information </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_slave.c @addtogroup
iic_v3_4 @{ Contains slave functions for the XIic component. This file is
necessary when slave operations, sending and receiving data as a slave on the
IIC bus, are desired. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
------- 1.01b jhl 3/26/02 repartioned the driver 1.01c ecm 12/05/02 new rev
1.13a wgr 03/22/07 Converted to new coding style. 1.15a ktn 03/18/09 Minor
changes to comply to Doxygen 2.00a ktn 10/22/09 Converted all register accesses
to 32 bit access. Updated to use the HAL APIs/macros. Removed the macro
XIic_mEnterCriticalRegion and used XIic_IntrGlobalDisable int its place. Removed
the macro XIic_mExitCriticalRegion and used XIic_IntrGlobalEnable in its place.
Some of the macros have been renamed to remove _m from the name and some of the
macros have been renamed to be consistent, see the xiic_i.h and xiic_l.h files
for further information 2.03a rkv 01/25/11 Updated in NAAS interrupt handler to
support data received less than FIFO size prior to NAAS interrupt. Fixed for
CR590212. 2.04a sdm 07/22/11 Added IsSlaveSetAckOff flag to the instance
structure. The IsSlaveSetAckOff is set when the Slave has set the Ack Off in the
RecvSlaveData function and is cleared in the NotAddrAsSlaveHandler when the
master has released the bus. This flag is to be used by slave applications for
recovering when it has gone out of sync with the master. CR 615004. 3.1 adk
01/08/15 When configured as a slave return the actual number of bytes have been
received/sent by the Master to the user callback (CR: 828504). </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_slave.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiic_stats.c @addtogroup
iic_v3_4 @{ Contains statistics functions for the XIic component. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- ------- 1.01b jhl 3/26/02
repartioned the driver 1.01c ecm 12/05/02 new rev 1.13a wgr 03/22/07 Converted
to new coding style. 2.00a ktn 10/22/09 Converted all register accesses to 32
bit access. Updated to use the HAL APIs/macros. XIic_ClearStats function is
updated as the macro XIIC_CLEAR_STATS has been removed. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iic/src/xiic_stats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/22/11 Created 2.0 adk 12/10/13 Updated
as per the New Tcl API's uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/iicps/data/iicps.tcl
XilinxProcessorIPLib/drivers/scuwdt/data/scuwdt.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 2.0 adk 12/10/13 Updated as per the New Tcl
API's Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0
: MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/iicps/data/iicps_tapp.tcl
XilinxProcessorIPLib/drivers/iomodule/data/iomodule_tapp.tcl
XilinxProcessorIPLib/drivers/scutimer/data/scutimer_tapp.tcl
XilinxProcessorIPLib/drivers/scuwdt/data/scuwdt_tapp.tcl
XilinxProcessorIPLib/drivers/spips/data/spips_tapp.tcl
XilinxProcessorIPLib/drivers/wdtps/data/wdtps_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_eeprom_intr_example.c
This file consists of a interrutp mode design example which uses the Xilinx PS
IIC device and XIicPs driver to exercise the EEPROM. The XIicPs_MasterSend() API
is used to transmit the data and the XIicPs_MasterRecv() API is used to receive
the data. The example is tested with a 2Kb/8Kb serial IIC EEPROM (ST
M24C02/M24C08). The WP pin of this EEPROM is hardwired to ground on the HW in
which this was tested. The AddressType should be u8 as the address pointer in
the on-board EEPROM is 1 bytes. This code assumes that no Operating System is
being used. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a sdm 03/15/10 First release 1.01a sg 04/13/12 Added MuxInit
function for initializing the IIC Mux on the ZC702 board and to configure it for
accessing the IIC EEPROM. Updated to use usleep instead of delay loop 1.04a hk
09/03/13 Removed GPIO code to pull MUX out of reset - CR722425. 2.3 sk 10/07/14
Removed multiple initializations for read buffer. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_eeprom_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_eeprom_polled_example.c
This file consists of a polled mode design example which uses the Xilinx PS IIC
device and XIicPs driver to exercise the EEPROM. The XIicPs_MasterSendPolled()
API is used to transmit the data and XIicPs_MasterRecvPolled() API is used to
receive the data. The example is tested with a 2Kb/8Kb serial IIC EEPROM (ST
M24C02/M24C08). The WP pin of this EEPROM is hardwired to ground in the HW in
which this was tested. The AddressType should be u8 as the address pointer in
the on-board EEPROM is 1 bytes. This code assumes that no Operating System is
being used. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a sdm 03/15/10 First release 1.01a sg 04/13/12 Added MuxInit
function for initializing the IIC Mux on the ZC702 board and to configure it for
accessing the IIC EEPROM. Updated to use usleep instead of delay loop 1.04a hk
09/03/13 Removed GPIO code to pull MUX out of reset - CR722425. 2.3 sk 10/07/14
Removed multiple initializations for read buffer. 3.3 Nava 08/08/16 Adopt the
Dynamic EEPROM finding support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_eeprom_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_intr_master_example.c
Design example to use the IIC device as master in interrupt-driven mode. It
continuously sends 18 buffers to slave. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00a jz 01/30/10 First release </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_intr_master_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xiicps_intr_multimaster_example.c Design example is to demonstrate multi-master
support in interrupt mode. In case of arbitration lost interrupt there will be
retry in example. The XIicPs_MasterSend() API is used to transmit the data and
the XIicPs_MasterRecv() API is used to receive the data. This example tested on
ZCU102 board and slave address needs to be changed based on board design It
continuously sends 18 buffers of different length to the slave. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a sg 03/09/19
First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_intr_multi_master_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_intr_slave_example.c A
design example of using the IIC device as slave for interrupt-driven transfers
using the external Aardvark IIC analyzer as the master. This example uses buffer
size of 250. Set the send buffer of the Aardvark device as continuous data from
0x00 to 0xF9. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 1.00a jz 01/30/10 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_intr_slave_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_polled_master_example.c
A design example of using the device in polled mode as master. The example uses
buffer size 132. Please set the send buffer of the Aardvark device to be
continuous 64 bytes from 0x00 to 0x3F. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00a jz 01/30/10 First release </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_polled_master_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xiicps_polled_multimaster_example.c Design example is to demonstrate multi-
master support in polled mode. In case arbitration lost there will be retry..
The XIicPs_MasterSendPolled() API is used to transmit the data and the
XIicPs_MasterRecvPolled() API is used to receive the data. This example tested
on ZCU102 board and slave address needs to be changed based on board design The
example uses buffer size 132. Please set the send buffer of the Aardvark device
to be continuous 64 bytes from 0x00 to 0x3F. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- --- -------- 1.00a sg 03/09/19 First release </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_polled_multi_master_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_polled_slave_example.c A
design example of using the device as slave in polled mode. This example uses
buffer of size 250. Please set the send buffer of the Aardvark device to be
continuous data from 0x00 to 0xF9. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00a jz 01/30/10 First release </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_polled_slave_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_repeated_start_example.c
This file consists of a repeated start example using xiicps driver in polled
mode. The slave used is an EEPROM. The example is tested with a 2Kb/8Kb serial
IIC EEPROM (ST M24C02/M24C08). The WP pin of this EEPROM is hardwired to ground
in the HW in which this was tested. This example can be used directly to read up
to 16 pages from start address in this EEPROM (Since single address byte). The
AddressType should be u8 as the address pointer in the on-board EEPROM is 1
bytes. This code assumes that no Operating System is being used. @note The I2C
controller does not indicate completion of a receive transfer if HOLD bit is
set. Due to this errata, repeated start cannot be used if a receive transfer is
followed by any other transfer on Zynq platform. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 2.1 hk 03/15/10 First release 3.7 ask
04/17/18 Updated the Eeprom scanning mechanism as per the other examples
(CR997545) </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_repeated_start_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_selftest_example.c This
file contains a example for using the IIC hardware device and XIicPs driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a sdm
05/30/11 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_slave_monitor_example.c
A design example of using the device as master to check slave's availability.
@note Please set the slave address to 0x3FB, which tests the device's ability to
handle 10-bit address. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 1.00a jz 01/30/10 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/examples/xiicps_slave_monitor_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps.c @addtogroup
iicps_v3_10 @{ Contains implementation of required functions for the XIicPs
driver. See xiicps.h for detailed description of the device and driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a drg/jz
01/30/10 First release 1.00a sdm 09/21/11 Updated the InstancePtr->Options in
the XIicPs_CfgInitialize by calling XIicPs_GetOptions. 2.1 hk 04/25/14
Explicitly reset CR and clear FIFO in Abort function and state the same in the
comments. CR 784254. Fix for CR 761060 - provision for repeated start. 2.3 sk
10/07/14 Repeated start feature removed. 3.0 sk 11/03/14 Modified TimeOut
Register value to 0xFF in XIicPs_Reset. 12/06/14 Implemented Repeated start
feature. 01/31/15 Modified the code according to MISRAC 2012 Compliant. 3.3 kvn
05/05/16 Modified latest code for MISRA-C:2012 Compliance. </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps.h @addtogroup
iicps_v3_10 @{ @details This is an implementation of IIC driver in the PS block.
The device can be either a master or a slave on the IIC bus. This implementation
supports both interrupt mode transfer and polled mode transfer. Only 7-bit
address is used in the driver, although the hardware also supports 10-bit
address. IIC is a 2-wire serial interface. The master controls the clock, so it
can regulate when it wants to send or receive data. The slave is under control
of the master, it must respond quickly since it has no control of the clock and
must send/receive data as fast or as slow as the master does. The higher level
software must implement a higher layer protocol to inform the slave what to send
to the master. <b>Initialization & Configuration</b> The XIicPs_Config structure
is used by the driver to configure itself. This configuration structure is
typically created by the tool-chain based on HW build properties. To support
multiple runtime loading and initialization strategies employed by various
operating systems, the driver instance can be initialized in the following way:
- XIicPs_LookupConfig(DeviceId) - Use the device identifier to find the static
configuration structure defined in xiicps_g.c. This is setup by the tools. For
some operating systems the config structure will be initialized by the software
and this call is not needed. - XIicPs_CfgInitialize(InstancePtr, CfgPtr,
EffectiveAddr) - Uses a configuration structure provided by the caller. If
running in a system with address translation, the provided virtual memory base
address replaces the physical address in the configuration structure.
<b>Multiple Masters</b> More than one master can exist, bus arbitration is
defined in the IIC standard. Lost of arbitration causes arbitration loss
interrupt on the device. <b>Multiple Slaves</b> Multiple slaves are supported by
selecting them with unique addresses. It is up to the system designer to be sure
all devices on the IIC bus have unique addresses. <b>Addressing</b> The IIC
hardware can use 7 or 10 bit addresses. The driver provides the ability to
control which address size is sent in messages as a master to a slave device.
<b>FIFO Size </b> The hardware FIFO is 32 bytes deep. The user must know the
limitations of other IIC devices on the bus. Some are only able to receive a
limited number of bytes in a single transfer. <b>Data Rates</b> The data rate is
set by values in the control register. The formula for determining the correct
register values is: Fscl Fpclk/(22 x (divisor_a+1) x (divisor_b+1)) When the
device is configured as a slave, the slck setting controls the sample rate and
so must be set to be at least as fast as the fastest scl expected to be seen in
the system. <b>Polled Mode Operation</b> This driver supports polled mode
transfers. <b>Interrupts</b> The user must connect the interrupt handler of the
driver, XIicPs_InterruptHandler to an interrupt system such that it will be
called when an interrupt occurs. This function does not save and restore the
processor context such that the user must provide this processing. The driver
handles the following interrupts: - Transfer complete - More Data - Transfer not
Acknowledged - Transfer Time out - Monitored slave ready - master mode only -
Receive Overflow - Transmit FIFO overflow - Receive FIFO underflow - Arbitration
lost <b>Bus Busy</b> Bus busy is checked before the setup of a master mode
device, to avoid unnecessary arbitration loss interrupt. <b>RTOS
Independence</b> This driver is intended to be RTOS and processor independent.
It works with physical addresses only. Any needs for dynamic memory management,
threads or thread mutual exclusion, virtual memory, or cache control must be
satisfied by the layer above this driver. <b>Repeated Start</b> The I2C
controller does not indicate completion of a receive transfer if HOLD bit is
set. Due to this errata, repeated start cannot be used if a receive transfer is
followed by any other transfer. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00a drg/jz 01/30/08 First release 1.00a sdm 09/21/11
Fixed an issue in the XIicPs_SetOptions and XIicPs_ClearOptions where the
InstancePtr->Options was not updated correctly. Updated the InstancePtr->Options
in the XIicPs_CfgInitialize by calling XIicPs_GetOptions. Updated the
XIicPs_SetupMaster to not check for Bus Busy condition when the Hold Bit is set.
Removed some unused variables. 1.01a sg 03/30/12 Fixed an issue in
XIicPs_MasterSendPolled where a check for transfer completion is added, which
indicates the completion of current transfer. 1.02a sg 08/29/12 Updated the
logic to arrive at the best divisors to achieve I2C clock with minimum error for
CR 674195 1.03a hk 05/04/13 Initialized BestDivA and BestDivB to 0. This is fix
for CR704398 to remove warning. 2.0 hk 03/07/14 Added check for error status in
the while loop that checks for completion. (XIicPs_MasterSendPolled function).
CR 762244, 764875. Limited frequency set when 100KHz or 400KHz is selected. This
is a hardware limitation. CR779290. 2.1 hk 04/24/14 Fix for CR 789821 to handle
>14 byte transfers. Explicitly reset CR and clear FIFO in Abort function and
state the same in the comments. CR 784254. Fix for CR 761060 - provision for
repeated start. 2.2 hk 08/23/14 Slave monitor mode changes - clear FIFO, enable
read mode and clear transfer size register. Disable NACK to avoid interrupts on
each retry. 2.3 sk 10/07/14 Repeated start feature deleted. 3.0 sk 11/03/14
Modified TimeOut Register value to 0xFF in XIicPs_Reset. 12/06/14 Implemented
Repeated start feature. 01/31/15 Modified the code according to MISRAC 2012
Compliant. 02/18/15 Implemented larger data transfer using repeated start in
Zynq UltraScale MP. 3.3 kvn 05/05/16 Modified latest code for MISRA-C:2012
Compliance. ms 03/17/17 Added readme.txt file in examples folder for doxygen
generation. 3.7 ask 04/17/18 Updated the Eeprom scanning mechanism as per the
other examples (CR997545) 3.8 ask 08/01/18 Fix for Cppcheck and Doxygen warnings
3.8 sd 09/06/18 Enable the Timeout interrupt 3.9 sg 03/09/19 Added arbitration
lost support in polled transfer </pre>

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_g.c @addtogroup
iicps_v3_10 @{ This file contains a configuration table that specifies the
configuration of IIC devices in the system. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00a drg/jz 01/30/10 First release 2.00 hk
22/01/14 Added check for picking second instance 3.00 sk 01/31/15 Modified the
code according to MISRAC 2012 Compliant. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_hw.c @addtogroup
iicps_v3_10 @{ Contains implementation of required functions for providing the
reset sequence to the i2c interface <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.04a kpc 11/07/13 First release 3.0 sk 11/03/14
Modified TimeOut Register value to 0xFF 01/31/15 Modified the code according to
MISRAC 2012 Compliant. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_hw.h @addtogroup
iicps_v3_10 @{ This header file contains the hardware definition for an IIC
device. It includes register definitions and interface functions to read/write
the registers. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a drg/jz 01/30/10 First release 1.04a kpc 11/07/13 Added function
prototype. 3.0 sk 11/03/14 Modified the TimeOut Register value to 0xFF 01/31/15
Modified the code according to MISRAC 2012 Compliant. 3.10 sg 06/24/19 Added
timeout macro for polled transfer. </pre>

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_intr.c @addtogroup
iicps_v3_10 @{ Contains functions of the XIicPs driver for interrupt-driven
transfers. See xiicps.h for a detailed description of the device and driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a
drg/jz 01/30/10 First release 3.00 sk 01/31/15 Modified the code according to
MISRAC 2012 Compliant. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_master.c @addtogroup
iicps_v3_10 @{ Handles master mode transfers. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.00a jz 01/30/10 First release 1.00a sdm
09/21/11 Updated the XIicPs_SetupMaster to not check for Bus Busy condition when
the Hold Bit is set. 1.01a sg 03/30/12 Fixed an issue in XIicPs_MasterSendPolled
where a check for transfer completion is added, which indicates the completion
of current transfer. 2.0 hk 03/07/14 Added check for error status in the while
loop that checks for completion. CR 762244, 764875. 2.1 hk 04/24/14 Fix for CR
789821 to handle >14 byte transfers. Fix for CR 761060 - provision for repeated
start. 2.2 hk 08/23/14 Slave monitor mode changes - clear FIFO, enable read mode
and clear transfer size register. Disable NACK to avoid interrupts on each
retry. 2.3 sk 10/06/14 Fill transmit fifo before address register when sending.
Replaced XIICPS_DATA_INTR_DEPTH with XIICPS_FIFO_DEPTH. Repeated start feature
removed. 3.0 sk 12/06/14 Implemented Repeated start feature. 01/31/15 Modified
the code according to MISRAC 2012 Compliant. 02/18/15 Implemented larger data
transfer using repeated start in Zynq UltraScale MP. 3.3 kvn 05/05/16 Modified
latest code for MISRA-C:2012 Compliance. 3.6 ask 09/03/18 In
XIicPs_MasterRecvPolled, set transfer size register before slave address. Fix
for CR996440. 3.8 sd 09/06/18 Enable the Timeout interrupt 3.9 sg 03/09/19 Added
arbitration lost support in polled transfer </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_master.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_options.c @addtogroup
iicps_v3_10 @{ Contains functions for the configuration of the XIccPs driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a
drg/jz 01/30/10 First release 1.02a sg 08/29/12 Updated the logic to arrive at
the best divisors to achieve I2C clock with minimum error. This is a fix for CR
674195 1.03a hk 05/04/13 Initialized BestDivA and BestDivB to 0. This is fix for
CR704398 to remove warning. 2.0 hk 03/07/14 Limited frequency set when 100KHz or
400KHz is selected. This is a hardware limitation. CR779290. 2.1 hk 04/24/14 Fix
for CR 761060 - provision for repeated start. 2.3 sk 10/07/14 Repeated start
feature removed. 3.0 sk 12/06/14 Implemented Repeated start feature. 01/31/15
Modified the code according to MISRAC 2012 Compliant. 3.3 kvn 05/05/16 Modified
latest code for MISRA-C:2012 Compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_selftest.c @addtogroup
iicps_v3_10 @{ This component contains the implementation of selftest functions
for the XIicPs driver component. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00a drg/jz 01/30/10 First release 1.00a sdm
09/22/11 Removed unused code 3.0 sk 11/03/14 Removed TimeOut Register value
check 01/31/15 Modified the code according to MISRAC 2012 Compliant. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_sinit.c @addtogroup
iicps_v3_10 @{ The implementation of the XIicPs component's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00a drg/jz 01/30/10 First release 3.00 sk 01/31/15
Modified the code according to MISRAC 2012 Compliant. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiicps_slave.c @addtogroup
iicps_v3_10 @{ Handles slave transfers <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- -- -------- 1.00a jz 01/30/10 First release 1.04a kpc 08/30/13
Avoid buffer overwrite in SlaveRecvData function 3.00 sk 01/31/15 Modified the
code according to MISRAC 2012 Compliant. 3.3 kvn 05/05/16 Modified latest code
for MISRA-C:2012 Compliance. 3.8 ask 08/01/18 Fix for Cppcheck and Doxygen
warnings. 3.10 sg 06/24/19 Fix for Slave send polled and interruput transfers.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iicps/src/xiicps_slave.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Removed support for dcr_intc
intc_core xps_intc @BEGIN_CHANGELOG EDK_M 11/18/09 ktn Removed support for
opb_intc @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3 06/16/10 sv Added support for
axi_intc @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/intc/data/intc.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's 3.5 sk 11/09/15 Removed delete filename statement CR 784758. 3.7 ms
04/18/17 Modified tcl file to add suffix U for macro definitions of intc in
xparameters.h 3.9 adk 19/12/18 If design contains unconnected interrupt pins
return proper error message CR1018878 @BEGIN_CHANGELOG 09/17/07 ecm Removed the
PCI specific connections Moved to the Linux MLD. 10/24/07 rpm Fixed KIND_OF_INTR
bug in canonicals and also generalized match on external interrupts 06/25/09 sdm
Updated so that canonical definitions are not generated when instance name
matches canonical name 04/27/10 sdm Updated the tcl so that the definitions are
generated in the xparameters.h to know whether the optional registers SIE, CIE
and IVR are enabled in the HW - Refer CR 555392 05/24/11 hvm updated tcl to
generate vector ids for external interrupts CR565336 06/15/11 hvm Updated tcl
with bypassing the external interrupt definition in xredefine_intc function.
CR613925. 01/19/12 Updated the intc_define_use_dcr function so that it doesnot
error out if there is more than one bus interface to the intc controller. The
new common::version of the AXI_INTC can have two bus interfaces to support the
fast interrupt for MicroBlaze. Updated for the generation of the C_HAS_FAST
xparameters 08/16/12 bss added generation of C_IVAR_RESET_VALUE xparameters
01/29/13 bss Added check_cascade and get_intctype to support Cascade mode.
Modified intc_define_vector_table procedure to generate interrupt IDs as 32..63
and 64..95 and so on for Slave controllers in Cascade mode 01/22/14 bss Modified
check_cascade to fix CR764865 17/02/14 adk Fixed the CR:771287 in
intc_define_vector_table if number of interrupt ports not equal to total number
of interrupts returning immediately.And in the xredefine_intc if there is not
interrupt source returining immediately. 4/8/14 bss Modified xredefine_intc to
handle external interrupt pins correctly (CR799609). 11/3/14 adk added
generation of C_HAS_ILR parameter to xparameters.h (CR828046). 01/07/17 mus
Updated xredefine_intc to return immediately, if number of connected interrupt
sources are 0 (CR966295) 01/25/17 mus Updated xredefine_intc and
intc_define_vector_table functions to generate separate canonical definitions
and constants definitions for interrupt IDs/Masks, if interrupt pin of same IP
is connected to two axi intc pins 06/28/18 mus Updated check_cascade proc, to
add check for irq_in pin, while detecting cascaded interrupt controllers.It
fixes CR1005371. 04/10/19 mus Updated intc_update_source_array proc to consider
interrupt port width, while calculating total_source_intrs. It fixes CR1020269
@END_CHANGELOG Global interrupt handlers array, default handler routine

FILES:
XilinxProcessorIPLib/drivers/intc/data/intc.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's 3.1 adk 8/4/14 Fix the CR:783248 Modified the Cascade logic in the app tcl
@BEGIN_CHANGELOG EDK_I_SP1 - Initial Revision 01/30/13 bss Modified script to
skip tests for Slave controllers in Cascade mode 02/26/13 bss Modified get_intr
procedure to support Vivado designs @END_CHANGELOG Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/intc/data/intc_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_example.c This file
contains a design example using the Interrupt Controller driver (XIntc) and
hardware device. Please reference other device driver examples to see more
examples of how the intc and interrupts can be used by a software application.
This example shows the use of the Interrupt Controller both with a PowerPC and
MicroBlaze processor. @note This example can also be used for Cascade mode
interrupt controllers by using the interrupt IDs generated in xparameters.h. For
Cascade mode, Interrupt IDs are generated in xparameters.h as shown below:
Master/Primary INTC ______ | |-0 Secondary INTC | |-. ______ | |-. | |-32 Last
INTC | |-. | |-. ______ |______|<--31-----| |-. | |-64 | |-. | |-.
|______|<--63------| |-. | |-. |______|-95 All driver functions has to be called
using DeviceId/InstancePtr of Primary/Master Controller only. Driver functions
takes care of Slave Controllers based on Interrupt ID passed. User must not use
Interrupt source/ID 31 of Primary and Secondary controllers to call driver
functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00b jhl 02/13/02 First release 1.00c rpm 11/13/03 Updated to show microblaze
and PPC interrupt use and to use the common L0/L1 interrupt handler with device
ID. 1.00c sv 06/29/05 Minor changes to comply to Doxygen and coding guidelines
2.00a ktn 10/20/09 Updated to use HAL Processor APIs amd minor modifications as
per coding guidelines. 3.6 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/examples/xintc_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_low_level_example.c This
file contains a design example using the low level-0 driver, interface of the
Interrupt Controller driver. This example shows the use of the Interrupt
Controller both with a PowerPC and a MicroBlaze processor. @note This example
can also be used for Cascade mode interrupt controllers by using the interrupt
IDs generated in xparameters.h. For Cascade mode, Interrupt IDs are generated in
xparameters.h as shown below: Master/Primary INTC ______ | |-0 Secondary INTC |
|-. ______ | |-. | |-32 Last INTC | |-. | |-. ______ |______|<--31-----| |-. |
|-64 | |-. | |-. |______|<--63------| |-. | |-. |______|-95 All driver functions
has to be called using BaseAddress of Primary/Master Controller only. Driver
functions takes care of Slave Controllers based on Interrupt ID passed. User
must not use Interrupt source/ID 31 of Primary and Secondary controllers to call
driver functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00c rpm 12/04/03 First release 1.00c sv 06/29/05 Minor changes to
comply to Doxygen and coding guidelines 2.00a ktn 10/20/09 Updated to use HAL
Processor APIs and _m is removed from all the macro names/definitions. Minor
changes done as per coding guidelines. 3.6 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/examples/xintc_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_tapp_example.c This file
contains a self test example using the Interrupt Controller driver (XIntc) and
hardware device. Please reference other device driver examples to see more
examples of how the Intc and interrupts can be used by a software application.
This example shows the use of the Interrupt Controller both with a PowerPC405
and MicroBlaze processor. The TestApp Gen utility uses this file to perform the
self test and setup of Intc for interrupts. @note None <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sv 06/29/05 Created for
Test App Integration 1.00c sn 05/09/06 Added Interrupt Setup Function 2.00a ktn
10/20/09 Updated to use HAL Processor APIs and minor changes as per coding
guidelines. 3.6 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/examples/xintc_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc.c @addtogroup intc_v3_9
@{ Contains required functions for the XIntc driver for the Xilinx Interrupt
Controller. See xintc.h for a detailed description of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm
08/16/01 First release 1.00b jhl 02/21/02 Repartitioned the driver for smaller
files 1.00b jhl 04/24/02 Made LookupConfig global and compressed ack before
table in the configuration into a bit mask 1.00c rpm 10/17/03 New release.
Support the static vector table created in the xintc_g.c configuration table.
1.00c rpm 04/23/04 Removed check in XIntc_Connect for a previously connected
handler. Always overwrite the vector table handler with the handler provided as
an argument. 1.10c mta 03/21/07 Updated to new coding style 1.11a sv 11/21/07
Updated driver to support access through a DCR bridge 2.00a ktn 10/20/09 Updated
to use HAL Processor APIs. 2.04a bss 01/13/12 Added XIntc_ConnectFastHandler API
for Fast Interrupt and XIntc_SetNormalIntrMode for setting to normal interrupt
mode. 2.05a bss 08/16/12 Updated to support relocatable vectors in Microblaze,
updated XIntc_SetNormalIntrMode to use IntVectorAddr which is the interrupt
vector address 2.06a bss 01/28/13 To support Cascade mode: Modified
XIntc_Initialize,XIntc_Start,XIntc_Connect
XIntc_Disconnect,XIntc_Enable,XIntc_Disable,
XIntc_Acknowledge,XIntc_ConnectFastHandler and XIntc_SetNormalIntrMode APIs.
Added XIntc_InitializeSlaves API. 3.0 bss 01/28/13 Modified to initialize IVAR
register with XPAR_MICROBLAZE_BASE_VECTORS + 0x10 to fix CR765931 3.9 sa
03/18/19 Modified XIntc_ConnectFastHandler, XIntc_SetNormalIntrMode and
XIntc_InitializeSlaves APIs to support vector addresses of width > 32 bits.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc.h @addtogroup intc_v3_9
@{ @details The Xilinx interrupt controller driver component. This component
supports the Xilinx interrupt controller. The interrupt controller driver uses
the idea of priority for the various handlers. Priority is an integer within the
range of 0 and 31 inclusive with 0 being the highest priority interrupt source.
The Xilinx interrupt controller supports the following features: - specific
individual interrupt enabling/disabling - specific individual interrupt
acknowledging - attaching specific callback function to handle interrupt source
- master enable/disable - single callback per interrupt or all pending
interrupts handled for each interrupt of the processor The acknowledgement of
the interrupt within the interrupt controller is selectable, either prior to the
device's handler being called or after the handler is called. This is necessary
to support interrupt signal inputs which are either edge or level signals. Edge
driven interrupt signals require that the interrupt is acknowledged prior to the
interrupt being serviced in order to prevent the loss of interrupts which are
occurring extremely close together. A level driven interrupt input signal
requires the interrupt to acknowledged after servicing the interrupt to ensure
that the interrupt only generates a single interrupt condition. Details about
connecting the interrupt handler of the driver are contained in the source file
specific to interrupt processing, xintc_intr.c. This driver is intended to be
RTOS and processor independent. It works with physical addresses only. Any needs
for dynamic memory management, threads or thread mutual exclusion, virtual
memory, or cache control must be satisfied by the layer above this driver.
<b>Interrupt Vector Tables</b> The interrupt vector table for each interrupt
controller device is declared statically in xintc_g.c within the configuration
data for each instance. The device ID of the interrupt controller device is used
by the driver as a direct index into the configuration data table - to retrieve
the vector table for an instance of the interrupt controller. The user should
populate the vector table with handlers and callbacks at run-time using the
XIntc_Connect() and XIntc_Disconnect() functions. Each vector table entry
corresponds to a device that can generate an interrupt. Each entry contains an
interrupt handler function and an argument to be passed to the handler when an
interrupt occurs. The tools default this argument to the base address of the
interrupting device. Note that the device driver interrupt handlers given in
this file do not take a base address as an argument, but instead take a pointer
to the driver instance. This means that although the table is created
statically, the user must still use XIntc_Connect() when the interrupt handler
takes an argument other than the base address. This is only to say that the
existence of the static vector tables should not mislead the user into thinking
they no longer need to register/connect interrupt handlers with this driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm
08/16/01 First release 1.00a rpm 01/09/02 Removed the AckLocation argument from
XIntc_Connect(). This information is now internal in xintc_g.c. 1.00b jhl
02/13/02 Repartitioned the driver for smaller files 1.00b jhl 04/24/02 Made
LookupConfig function global and relocated config data type 1.00c rpm 10/17/03
New release. Support the static vector table created in the xintc_g.c
configuration table. Moved vector table and options out of instance structure
and into the configuration table. 1.10c mta 03/21/07 Updated to new coding style
1.11a sv 11/21/07 Updated driver to support access through a DCR bridge 2.00a
ktn 10/20/09 Updated to use HAL Processor APIs and _m is removed from all the
macro names/definitions. 2.01a sdm 04/27/10 Updated the tcl so that the
definitions are generated in the xparameters.h to know whether the optional
registers SIE, CIE and IVR are enabled in the HW - Refer CR 555392. This driver
doesnot make use of these definitions and does not use the optional registers.
2.03a hvm 05/24/11 Updated the tcl to generate vector Ids for external
interrupts. CR565336 2.04a bss 01/13/12 Added XIntc_ConnectFastHandler API for
Fast Interrupt and XIntc_SetNormalIntrMode for setting to normal interrupt mode.
2.04a asa 03/19/12 Changed the XIntc_Config struct. The order of entries
declared in the structure now matches with the XIntc_ConfigTable generated by
the driver tcl. 2.05a bss 08/16/12 Updated to support relocatable vectors in
Microblaze, added IntVectorAddr to XIntc_Config for this. Added
XIntc_RegisterFastHandler API to register fast interrupt handlers using base
address. 2.06a bss 01/28/13 To support Cascade mode: Added
XIN_INTC_NOCASCADE,XIN_INTC_PRIMARY, XIN_INTC_SECONDARY,XIN_INTC_LAST and
XIN_CONTROLLER_MAX_INTRS macros Added NumberofIntrs and IntcType fields in
XIntc_Config structure. Modified XIntc_Initialize,XIntc_Start,XIntc_Connect
XIntc_Disconnect,XIntc_Enable,XIntc_Disable,
XIntc_Acknowledge,XIntc_ConnectFastHandler and XIntc_SetNormalIntrMode
APIs.Added XIntc_InitializeSlaves API in xintc.c Modified
XIntc_DeviceInterruptHandler, XIntc_SetIntrSvcOption,XIntc_RegisterHandler and
XIntc_RegisterFastHandler APIs.Added XIntc_CascadeHandler API in xintc_l.c.
Modified XIntc_SetOptions API in xintc_options.c. Modified XIntc_SimulateIntr
API in xintc_selftest.c. Modified driver tcl: to check for Cascade mode and
generate XPAR_INTC_TYPE for each controller. Generate
XPAR_INTC_MAX_NUM_INTR_INPUTS by adding all interrupt sources of all Controllers
in Cascade mode. 2.07a bss 10/18/13 To support Nested interrupts: Modified
XIntc_DeviceInterruptHandler API. Added XIN_ILR_OFFSET macro in xintc_l.h.
Modified driver tcl to generate HAS_ILR parameter in xparameters.h 3.0 bss
01/28/13 Modified xintc.c to initialize IVAR register with
XPAR_MICROBLAZE_BASE_VECTORS + 0x10 to fix CR765931. Modified driver tcl to
generate XPAR_AXI_INTC_0_TYPE correctly(CR764865). 3.10 mus 04/10/19 Updated
intc_update_source_array proc to calculate total_source_intrs, based on the
width of interrupt port/pins. @note For Cascade mode, Interrupt IDs are
generated in xparameters.h as shown below: Master/Primary INTC ______ | |-0
Secondary INTC | |-. ______ | |-. | |-32 Last INTC | |-. | |-. ______
|______|<-31------| |-. | |-64 | |-. | |-. |______|<-63-------| |-. | |-.
|______|-95 All driver functions has to be called using DeviceId/
InstancePtr/BaseAddress of Primary/Master Controller and Interrupts IDs
generated in xparameters.h only. Driver functions takes care of Slave
Controllers based on Interrupt ID passed. User must not use Interrupt source/ID
31 of Primary and Secondary controllers to call driver functions. For nested
interrupts, XIntc_DeviceInterruptHandler saves microblaze r14 register on entry
and restores on exit. This is required since compiler does not support nesting.
It enables Microblaze interrupts after blocking further interrupts from the
current interrupt number and interrupts below current interrupt priority by
writing to Interrupt Level Register of INTC on entry. On exit, it disables
microblaze interrupts and restores ILR register default value(0xFFFFFFFF)back.
It is recommended to increase STACK_SIZE in linker script for nested interrupts.
3.0 adk 12/10/13 Updated as per the New Tcl API's 3.0 adk 17/02/14 Fixed the
CR:771287 Changes are made in the intc driver tcl. 3.1 adk 8/4/14 Fixed the
CR:783248 Changes are made in the test-app tcl 3.2 bss 4/8/14 Fixed driver tcl
to handle external interrupt pins correctly (CR799609). 3.3 adk 11/3/14 added
generation of C_HAS_ILR parameter to xparameters.h.Changes are made in the
driver tcl file (CR828046). 3.5 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. 3.6 ms 01/23/17 Added xil_printf statement in main
function for all examples to ensure that "Successfully ran" and "Failed" strings
are available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. 3.7 ms 04/18/17
Modified tcl file to add suffix U for macro definitions of intc in xparameters.h
3.9 adk 19/12/18 If design contains unconnected interrupt pins return proper
error message(CR1018878). </pre>

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_g.c @addtogroup intc_v3_9
@{ This file contains a configuration table that specifies the configuration of
interrupt controller devices in the system. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a rpm 01/09/02 First release 1.00b jhl
02/21/02 Repartitioned the driver for smaller files 1.00b jhl 04/24/02
Compressed the ack table into a bit mask. 1.00c rpm 10/17/03 New release.
Support the static vector table created in the xintc_g.c configuration table.
1.10c mta 03/21/07 Updated to new coding style </pre> @internal This
configuration table contains entries that are modified at runtime by the driver.
The EDK tools populate the table with default values for the vector table and
the options flag. These default values can be, and are, overwritten at runtime
by the driver. This is a deviation from most drivers' configuration tables in
that most are created statically by the tools and are never modified during
runtime. Most tables reflect only the hardware configuration of the device. This
Intc configuration table contains software information in addition to hardware
configuration. The Intc configuration table should be considered an exception to
the usage of the configuration table rather than the norm. Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_i.h @addtogroup intc_v3_9
@{ This file contains data which is shared between files and internal to the
XIntc component. It is intended for internal use only. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl 02/06/02 First
release 1.00b jhl 04/24/02 Moved register definitions to xintc_l.h 1.00c rpm
10/17/03 New release. Removed extern of global, single instance pointer. 1.10c
mta 03/21/07 Updated to new coding style 2.00a ktn 10/20/09 Updated to use HAL
Processor APIs. </pre>

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_intr.c @addtogroup
intc_v3_9 @{ This file contains the interrupt processing for the XIntc component
which is the driver for the Xilinx Interrupt Controller. The interrupt
processing is partitioned separately such that users are not required to use the
provided interrupt processing. This file requires other files of the driver to
be linked in also. Two different interrupt handlers are provided for this driver
such that the user must select the appropriate handler for the application. The
first interrupt handler, XIntc_VoidInterruptHandler, is provided for systems
which use only a single interrupt controller or for systems that cannot
otherwise provide an argument to the XIntc interrupt handler (e.g., the RTOS
interrupt vector handler may not provide such a facility). The constant
XPAR_INTC_SINGLE_DEVICE_ID must be defined for this handler to be included in
the driver. The second interrupt handler, XIntc_InterruptHandler, uses an input
argument which is an instance pointer to an interrupt controller driver such
that multiple interrupt controllers can be supported. This handler requires the
calling function to pass it the appropriate argument, so another level of
indirection may be required. Note that both of these handlers are now only
provided for backward compatibility. The handler defined in xintc_l.c is the
recommended handler. The interrupt processing may be used by connecting one of
the interrupt handlers to the interrupt system. These handlers do not save and
restore the processor context but only handle the processing of the Interrupt
Controller. The two handlers are provided as working examples. The user is
encouraged to supply their own interrupt handler when performance tuning is
deemed necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00b jhl 02/13/02 First release 1.00c rpm 10/17/03 New release.
Support the static vector table created in the xintc_g.c configuration table.
Collapse handlers to use the XIntc_DeviceInterruptHandler() in xintc_l.c. 1.00c
rpm 04/09/04 Added conditional compilation around the old handler
XIntc_VoidInterruptHandler(). This handler will only be include/compiled if
XPAR_INTC_SINGLE_DEVICE_ID is defined. 1.10c mta 03/21/07 Updated to new coding
style 2.00a ktn 10/20/09 Updated to use HAL Processor APIs. </pre> @internal
This driver assumes that the context of the processor has been saved prior to
the calling of the Interrupt Controller interrupt handler and then restored
after the handler returns. This requires either the running RTOS to save the
state of the machine or that a wrapper be used as the destination of the
interrupt vector to save the state of the processor and restore the state after
the interrupt handler returns. Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_l.c @addtogroup intc_v3_9
@{ This file contains low-level driver functions that can be used to access the
device. The user should refer to the hardware device specification for more
details of the device operation. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00b jhl 04/24/02 First release 1.00c rpm 10/17/03
New release. Support the static vector table created in the xintc_g.c
configuration table. 1.00c rpm 04/09/04 Added conditional compilation around the
old handler XIntc_LowLevelInterruptHandler(). This handler will only be
include/compiled if XPAR_INTC_SINGLE_DEVICE_ID is defined. 1.10c mta 03/21/07
Updated to new coding style 1.10c ecm 07/09/07 Read the ISR after the
Acknowledge in the interrupt handler to support architectures with posted write
bus access issues. 2.00a ktn 10/20/09 Updated to use HAL Processor APIs and _m
is removed from all the macro definitions. 2.04a bss 01/13/12 Removed the unused
Register variable for warnings. 2.05a bss 08/18/12 Added
XIntc_RegisterFastHandler API to register fast interrupt handlers using base
address. 2.06a bss 01/28/13 To support Cascade mode: Modified
XIntc_DeviceInterruptHandler, XIntc_SetIntrSvcOption,XIntc_RegisterHandler and
XIntc_RegisterFastHandler APIs. Added XIntc_CascadeHandler API. 2.07a bss
10/18/13 Modified XIntc_DeviceInterruptHandler to support nested interrupts. 3.5
sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototypes of LookupConfigByBaseAddress, XIntc_SetIntrSvcOption,
XIntc_RegisterHandler, XIntc_RegisterFastHandler APIs. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_l.h @addtogroup intc_v3_9
@{ This header file contains identifiers and low-level driver functions (or
macros) that can be used to access the device. The user should refer to the
hardware device specification for more details of the device operation. Note
that users of the driver interface given in this file can register an interrupt
handler dynamically (at run-time) using the XIntc_RegisterHandler() function.
User of the driver interface given in xintc.h should still use XIntc_Connect(),
as always. Also see the discussion of the interrupt vector tables in xintc.h.
There are currently two interrupt handlers specified in this interface. -
XIntc_LowLevelInterruptHandler() is a handler without any arguments that is used
in cases where there is a single interrupt controller device in the system and
the handler cannot be passed an argument. This function is provided mostly for
backward compatibility. - XIntc_DeviceInterruptHandler() is a handler that takes
a device ID as an argument, indicating which interrupt controller device in the
system is causing the interrupt - thereby supporting multiple interrupt
controllers. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00b jhl 04/24/02 First release 1.00c rpm 10/17/03 New release.
Support the static vector table created in the xintc_g.c configuration table.
1.10c mta 03/21/07 Updated to new coding style 1.11a sv 11/21/07 Updated driver
to support access through a DCR bridge 2.00a ktn 10/20/09 Updated to use HAL
Processor APIs. _m is removed from all the macro definitions. 2.04a bss 01/13/12
Updated for adding defines for IMR and IVAR for the FAST Interrupt 2.05a bss
08/18/12 Added XIntc_RegisterFastHandler API to register fast interrupt handlers
using base address. 2.07a bss 10/18/13 Added XIN_ILR_OFFSET macro for nested
interrupts. 3.5 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR
867425. Changed the prototypes of XIntc_RegisterFastHandler,
XIntc_SetIntrSvcOption, XIntc_RegisterHandler APIs. </pre>

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_options.c @addtogroup
intc_v3_9 @{ Contains option functions for the XIntc driver. These functions
allow the user to configure an instance of the XIntc driver. This file requires
other files of the component to be linked in also. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00b jhl 02/21/02 First release 1.00c
rpm 10/17/03 New release. Support the relocation of the options flag from the
instance structure to the xintc_g.c configuration table. 1.10c mta 03/21/07
Updated to new coding style 2.00a ktn 10/20/09 Updated to use HAL Processor APIs
2.06a bss 01/28/13 To support Cascade mode: Modified XIntc_SetOptions API.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xintc_selftest.c @addtogroup
intc_v3_9 @{ Contains diagnostic self-test functions for the XIntc component.
This file requires other files of the component to be linked in also. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
02/21/02 First release 1.10c mta 03/21/07 Updated to new coding style 2.00a ktn
10/20/09 Updated to use HAL Processor APIs 2.04a bss 01/16/12 Removed CurrentMIE
variable and reading of the MER register to remove warnings 2.06a bss 01/28/13
To support Cascade mode: Modified XIntc_SimulateIntr API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/intc/src/xintc_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 2.0 adk 12/10/13 Updated as per the New Tcl
API's 2.0 bss 05/02/14 Modified to generate PITx_EXPIRED_MASK parameter to fix
CR794167. 2.2 nsk 21/07/15 Updated iomodule_define_vector_table by removing
absoluted hsi commands like xget_handle.CR865544. Modified generate proc to get
canonical definitions in xparameters.h. 2.2 nsk 07/08/15 Updated
iomodule_define_vector_table to handle External vector interrupts CR871572. 2.2
nsk 19/08/15 Modified iomodule_defince_vector_table to handle, if iomodule
doesn't have interrupts enabled CR876507. 2.2 nsk 02/09/15 Modified
iomodule_define_vector_table when no external interrupts are used.CR878782. 2.3
nsk 05/11/15 Updated xdefine_canonical_xpars such that Generate canonical
definitions, whose canonical name is not the same as hardware instance name. CR
876604. sk 11/09/15 Removed delete filename statement CR 784758. 2.5 ms 04/18/17
Modified tcl file to add suffix U for all macros definitions of iomodule in
xparameters.h 2.6 mus 09/25/18 Updated tcl to replace "hsi::get_cells
-of_object" with the "hsi::get_cells -of_objects". CR1011395. Global interrupt
handlers array, default handler routine

FILES:
XilinxProcessorIPLib/drivers/iomodule/data/iomodule.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_example.c This file
contains a self test example using the IO Module driver (XIoModule) and hardware
device. Please reference other device driver examples to see more examples of
how the interrupts, timers and UART can be used by a software application. @note
None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
sa 07/15/11 First release 2.4 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/examples/xiomodule_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_intr_example.c This
file contains a design example using the IO Module driver (XIOModule) and
hardware device using interrupt mode.This example tests the internal interrupts
in the IO Module. This file can be used as a standalone example or by the
TestAppGen utility to include a test of IOModule interrupts. @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 07/15/11
First release 2.4 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/examples/xiomodule_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_low_level_example.c
This file contains a design example using the low level-0 driver, interface of
the IO Module driver. @note None <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a sa 07/15/11 First release 2.4 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/examples/xiomodule_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_selftest_example.c
This file contains a self test example using the IO Module driver (XIOModule)
and hardware device. Please reference other device driver examples to see more
examples of how the interrupts, timers and UART can be used by a software
application. The TestApp Gen utility uses this file to perform the self test and
setup of the IO Module. @note None <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a sa 07/15/11 First release 2.4 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/examples/xiomodule_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule.c @addtogroup
iomodule_v2_7 @{ Contains required functions for the XIomodule driver for the
Xilinx IO Module Interrupt Controller. See xiomodule.h for a detailed
description of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a sa 07/15/11 First release 1.01a sa 04/10/12 Updated
with fast interrupt 2.1 bss 05/02/14 Modified XIOModule_IsExpired to check for
all 1's instead of 0 in CounterReg.(CR794167) 2.4 mi 09/20/16 Fixed compilation
warnings 2.5 ms 08/07/17 Fixed compilation warnings 2.7 mus 11/09/18 Updated
XIOModule_Initialize and XIOModule_ConnectFastHandler to deal with the vector
address > 32bit. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule.h @addtogroup
iomodule_v2_7 @{ @details The Xilinx IO Module driver component. This component
supports the IO Module. The IO Module provides: <ol> <li>Universal Asynchronous
Receiver Transmitter (UART)</li> <li>Fixed Interval Timer (FIT)</li>
<li>Programmable Interval Timer (PIT)</li> <li>General Purpose Output (GPO)</li>
<li>General Purpose Input (GPI)</li> <li>Interrupt controller (INTC)</li> <li>IO
bus (IO)</li> </ol> <b>Universal Asynchronous Receiver Transmitter (UART):</b>
This UART is a minimal hardware implementation with minimal features. Most of
the features, including parity, and number of data bits are only configurable
when the hardware device is built, rather than at run time by software. The UART
has an internal baud rate generator that is clocked at a specified input clock
frequency. The baud rate can either be fixed, or programmable. Not all
programmed baud rates can be generated from some clock frequencies. The
requested baud rate is checked using the provided clock for the system, and
checked against the acceptable error range. An error may be returned from some
functions indicating the baud rate was in error because it could not be
generated. The device has support for interrupts: a transmit interrupt, a
receive interrupt, and an error interrupt. The interrupts are individually
configurable when the hardware device is built. The driver defaults to no
interrupts at initialization such that interrupts must be enabled if desired. An
interrupt is generated when the transmitter transitions from having data to
being empty, when any data is contained in the receive register, or when an
error occurs in received data. In order to use interrupts, it's necessary for
the user to connect the driver interrupt handler, XIOModule_InterruptHandler, to
the interrupt system of the application. This function does not save and restore
the processor context such that the user must provide it. Send and receive
handlers may be set for the driver such that the handlers are called when
transmit and receive interrupts occur. The handlers are called from interrupt
context and are designed to allow application specific processing to be
performed. The functions, XIOModule_Send and XIOModule_Recv, are provided in the
driver to allow data to be sent and received. They are designed to be used in
polled or interrupt modes. The driver provides a status for each received byte
indicating any parity frame or overrun error. The driver provides statistics
which allow visibility into these errors. <b>Fixed Interval Timer (FIT):</b> The
fixed interval timer supports the following features: - Interrupt driven mode
The timer has a hardware programmed time period, which can be configured to
cause a periodic interrupt. The driver only provides the ability to handle such
interrupts. <b>Programmable Interval Timer (PIT):</b> The programmable interval
timer supports the following features: - Polled mode - Interrupt driven mode -
Enabling and disabling - Automatic reload The timer operates in compare mode.
The timer always counts down. Compare mode is typically used for creating a
single time period or multiple repeating time periods in the auto reload mode,
such as a periodic interrupt. When started, the timer loads an initial value,
referred to as the load value, into the timer and starts counting down. The
timer expires when it rolls under. An external Output signal may be configured
such that a pulse is generated with this signal when it rolls under. The timer
can be configured to cause an interrupt when the count reaches zero. An external
output is also toggled when the count reaches zero. <b>Interrupts</b> It is the
responsibility of the application to connect the interrupt handler of the timer
to the interrupt source. The interrupt handler function,
XIOModule_InterruptHandler, is visible such that the user can connect it to the
interrupt source. Note that this interrupt handler does not provide interrupt
context save and restore processing, the user must perform this processing. The
driver services interrupts and passes timeouts to the upper layer software
through callback functions. The upper layer software must register its callback
functions during initialization. The driver requires callback functions for
timers. <b>General Purpose Output (GPO):</b> The GPO has support for up to 32
I/O discrete outputs for each channel (128 bits total). <b>IO Bus (IO):</b> The
IO Bus provides a generic mechanism to extend the IO Module functionality by
providing a memory mapped IO area. Reading and writing of byte, halfword and
word data is provided. <b>General Purpose Input (GPI):</b> The GPI has support
for up to 32 I/O discrete outputs for each channel (128 bits total). An
interrupt can be generated when any bit in a GPI changes. <b>Interrupt
controller (INTC):</b> The interrupt controller driver uses the idea of priority
for the various handlers. Priority is an integer within the range of 0 and 31
inclusive with 0 being the highest priority interrupt source. The Xilinx
interrupt controller supports the following features: - specific individual
interrupt enabling/disabling - specific individual interrupt acknowledging -
attaching specific callback function to handle interrupt source - master
enable/disable - single callback per interrupt or all pending interrupts handled
for each interrupt of the processor The acknowledgement of the interrupt within
the interrupt controller is selectable, either prior to the device's handler
being called or after the handler is called. This is necessary to support
interrupt signal inputs which are either edge or level signals. Edge driven
interrupt signals require that the interrupt is acknowledged prior to the
interrupt being serviced in order to prevent the loss of interrupts which are
occurring extremely close together. A level driven interrupt input signal
requires the interrupt to acknowledged after servicing the interrupt to ensure
that the interrupt only generates a single interrupt condition. Details about
connecting the interrupt handler of the driver are contained in the source file
specific to interrupt processing, xiomodule_intr.c. This driver is intended to
be RTOS and processor independent. It works with physical addresses only. Any
needs for dynamic memory management, threads or thread mutual exclusion, virtual
memory, or cache control must be satisfied by the layer above this driver.
<b>Interrupt Vector Tables</b> The interrupt vector table for each interrupt
controller device is declared statically in xiomodule_g.c within the
configuration data for each instance. The device ID of the interrupt controller
device is used by the driver as a direct index into the configuration data table
- to retrieve the vector table for an instance of the interrupt controller. The
user should populate the vector table with handlers and callbacks at run-time
using the XIOModule_Connect() and XIOModule_Disconnect() functions. Each vector
table entry corresponds to a device that can generate an interrupt. Each entry
contains an interrupt handler function and an argument to be passed to the
handler when an interrupt occurs. The tools default this argument to the base
address of the interrupting device. Note that the device driver interrupt
handlers given in this file do not take a base address as an argument, but
instead take a pointer to the driver instance. This means that although the
table is created statically, the user must still use XIOModule_Connect() when
the interrupt handler takes an argument other than the base address. This is
only to say that the existence of the static vector tables should not mislead
the user into thinking they no longer need to register/connect interrupt
handlers with this driver. With fast interrupts enabled, the
XIOModule_ConnectFastHandler() function should be used instead of
XIOModule_Connect(). Note that the function pointer parameter Handler, must be a
declared with the fast_interrupt attribute: void Handler()
__attribute__((fast_interrupt)); The routine defined by XIOModule_Connect() can
be used by setting normal interrupt mode, using XIOModule_SetNormalIntrMode().
@note This API utilizes 32 bit I/O to the registers. With less than 32 bits, the
unused bits from registers are read as zero and written as don't cares. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 07/15/11
First release 1.01a sa 04/10/12 Updated with fast interrupt 1.02a sa 07/25/12
Updated with GPI interrupts and programmable baudrate 2.0 adk 19/12/13 Updated
as per the New Tcl API's 2.1 bss 05/02/14 Added PitMask in XIOModule_Config.(CR
794167) 2.2 nsk 07/21/15 Updated iomodule_define_vector_table by removing
absoluted hsi commands like xget_handle.CR865544. modified generate proc to get
canonical definitions in xparameters.h 2.2 nsk 08/06/15 Updated
XIOModule_Uart_InterruptHandler function in xiomodule_uart_intr.c file to read
Status register instead of reading Interrupt Pending register. (CR 862715). 2.2
nsk 08/07/15 Updated iomodule_define_vector_table in iomodule.tcl to handle
External vector interrupts.(CR 871572) 2.2 nsk 08/19/15 Modified
iomodule_define_vector_table in iomodule.tcl to handle,if iomodule doesn't have
interrupts enabled (CR 876507). 2.2 nsk 09/02/15 Modified
iomodule_define_vector_table in iomodule.tcl when no external interrupts are
used.(CR 878782) 2.3 nsk 11/05/15 Updated xdefine_canonical_xpars in
iomodule.tcl to Generate canonical definitions, whose canonical name is not the
same as hardware instance name. (CR 876604) 2.4 ms 01/23/17 Added xil_printf
statement in main function for all examples to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 03/17/17 Added readme.txt file in examples folder for doxygen generation. 2.5
ms 04/18/17 Modified tcl file to add suffix U for all macros definitions of
iomodule in xparameters.h ms 08/07/17 Fixed compilation warnings in xiomodule.c,
xiomodule_l.c, xiomodule_uart.c 2.7 sa 11/09/18 Updated XIOModule_Config to
support 64 bit base addresses. </pre>

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_extra.c @addtogroup
iomodule_v2_7 @{ The implementation of the XIOModule component's advanced
discrete functions. See xiomodule.h for more information about the component.
@note None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sa 07/15/11 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_extra.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_g.c @addtogroup
iomodule_v2_7 @{ This file contains a configuration table that specifies the
configuration of interrupt controller devices in the system. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 07/15/11 First
release </pre> @internal This configuration table contains entries that are
modified at runtime by the driver. The EDK tools populate the table with default
values for the vector table and the options flag. These default values can be,
and are, overwritten at runtime by the driver. This is a deviation from most
drivers' configuration tables in that most are created statically by the tools
and are never modified during runtime. Most tables reflect only the hardware
configuration of the device. This IOModule configuration table contains software
information in addition to hardware configuration. The IOModule configuration
table should be considered an exception to the usage of the configuration table
rather than the norm. Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_i.h @addtogroup
iomodule_v2_7 @{ This file contains data which is shared between files and
internal to the XIOModule component. It is intended for internal use only. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 07/15/11
First release 1.02a sa 07/25/12 Added UART prototypes </pre>

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_intr.c @addtogroup
iomodule_v2_7 @{ This file contains the interrupt processing for the XIOModule
component which is the driver for the Xilinx IO Module interrupt. The interrupt
processing is partitioned separately such that users are not required to use the
provided interrupt processing. This file requires other files of the driver to
be linked in also. Two different interrupt handlers are provided for this driver
such that the user must select the appropriate handler for the application. The
first interrupt handler, XIOModule_VoidInterruptHandler, is provided for systems
which use only a single interrupt controller or for systems that cannot
otherwise provide an argument to the XIOModule interrupt handler (e.g., the RTOS
interrupt vector handler may not provide such a facility). The constant
XPAR_IOMODULE_SINGLE_DEVICE_ID must be defined for this handler to be included
in the driver. The second interrupt handler, XIOModule_InterruptHandler, uses an
input argument which is an instance pointer to an interrupt controller driver
such that multiple interrupt controllers can be supported. This handler requires
the calling function to pass it the appropriate argument, so another level of
indirection may be required. Note that both of these handlers are now only
provided for backward compatibility. The handler defined in xiomodule_l.c is the
recommended handler. The interrupt processing may be used by connecting one of
the interrupt handlers to the interrupt system. These handlers do not save and
restore the processor context but only handle the processing of the Interrupt
Controller. The two handlers are provided as working examples. The user is
encouraged to supply their own interrupt handler when performance tuning is
deemed necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sa 07/15/11 First release 1.02a sa 07/25/12 Added UART interrupt
related functions 1.03a sa 10/16/12 Moved UART interrupt related functions to
separate file </pre> @internal This driver assumes that the context of the
processor has been saved prior to the calling of the IO Module interrupt handler
and then restored after the handler returns. This requires either the running
RTOS to save the state of the machine or that a wrapper be used as the
destination of the interrupt vector to save the state of the processor and
restore the state after the interrupt handler returns. Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_io.h @addtogroup
iomodule_v2_7 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. The user should
refer to the <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sa 07/15/11 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_io.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_l.c @addtogroup
iomodule_v2_7 @{ This file contains low-level driver functions that can be used
to access the device. The user should refer to the hardware device specification
for more details of the device operation. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a sa 07/15/11 First release 2.5 ms 08/07/17
Fixed compilation warnings 2.7 sa 11/09/18 Updated low level APIs to deal with
the 64 bit addresses </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_l.h @addtogroup
iomodule_v2_7 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. The user should
refer to the hardware device specification for more details of the device
operation. Note that users of the driver interface given in this file can
register an interrupt handler dynamically (at run-time) using the
XIntc_RegisterHandler() function. User of the driver interface given in
xiomodule.h should still use XIntc_Connect(), as always. Also see the discussion
of the interrupt vector tables in xiomodule.h. There are currently two interrupt
handlers specified in this interface. - XIOModule_LowLevelInterruptHandler() is
a handler without any arguments that is used in cases where there is a single
interrupt controller device in the system and the handler cannot be passed an
argument. This function is provided mostly for backward compatibility. -
XIOModule_DeviceInterruptHandler() is a handler that takes a device ID as an
argument, indicating which interrupt controller device in the system is causing
the interrupt - thereby supporting multiple interrupt controllers. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 07/15/11
First release 1.01a sa 04/10/12 Updated with fast interrupt 1.02a sa 07/25/12
Updated with GPI interrupt support 2.7 sa 11/09/18 Updated macros to support 64
bit addresses </pre>

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_options.c @addtogroup
iomodule_v2_7 @{ Contains option functions for the XIOModule driver. These
functions allow the user to configure an instance of the XIOModule driver. This
file requires other files of the component to be linked in also. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa 07/15/11
First release 2.4 mi 09/20/16 Fixed compilation warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_selftest.c
@addtogroup iomodule_v2_7 @{ Contains diagnostic self-test functions for the
XIOModule component. This file requires other files of the component to be
linked in also. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sa 07/15/11 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_stats.c @addtogroup
iomodule_v2_7 @{ This file contains the statistics functions for the UART module
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sa
07/15/11 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_stats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_uart.c @addtogroup
iomodule_v2_7 @{ Contains required functions for the XIOModule UART driver. See
the xiomodule.h header file for more details on this driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.02a sa 07/25/12 First
release 1.03a sa 10/16/12 Moved interrupt mode functions to separate file 2.4 mi
09/20/16 Fixed compilation warnings 2.5 ms 08/07/17 Fixed compilation warnings.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_uart.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xiomodule_uart_intr.c
@addtogroup iomodule_v2_7 @{ Contains required functions for the XIOModule UART
driver interrupt mode. See the xiomodule.h header file for more details on this
driver. This file also contains interrupt-related functions for the UART. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.03a sa 10/16/12
First release 2.2 nsk 08/06/15 Updated XIOModule_Uart_InterruptHandler function
to read Status register instead of reading Interrupt Pending register. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/iomodule/src/xiomodule_uart_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 mjr 02/03/15 Created 2.3 ms 04/11/17 Modified
tcl file to add U suffix for all macros of ipipsu in xparameters.h 2.5 sd
04/01/19 Added support for the the no buffer ipi sd 09/03/19 Add support for
versal ip name uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/ipipsu/data/ipipsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xipipsu_self_test_example.c
This file consists of a self test example which uses the XIpiPsu driver to send
an IPI message to self and get a response Each IPI channel can trigger an
interrupt to itself and can exchange messages through the message buffer. This
feature is used here to exercise the driver APIs. Example control flow: - Init
the IPI and GIC drivers - Setup Interrupt System with IPI handler which inverts
the received message and sends back as response - Write a Message and Trigger
IPI to Self. - Keep polling for response till timeout - Interrupt handler
receives IPI and sends back response - Read the received response and do a
sanity check - Print PASS or FAIL based on sanity check of response message
<pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 2.2 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre>

FILES:
XilinxProcessorIPLib/drivers/ipipsu/examples/xipipsu_self_test_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xipipsu.c @addtogroup
ipipsu_v2_5 @{ This file contains the implementation of the interface functions
for XIpiPsu driver. Refer to the header file xipipsu.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 mjr 03/15/15 First Release 2.0 mjr 01/22/16 Fixed response buffer
address calculation. CR 932582. 2.1 kvn 05/05/16 Modified code for MISRA-C:2012
Compliance 2.2 kvn 02/17/17 Add support for updating ConfigTable at run time 2.4
sd 07/11/18 Fix a doxygen reported warning </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ipipsu/src/xipipsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xipipsu.h @addtogroup
ipipsu_v2_5 @{ @details This is the header file for implementation of IPIPSU
driver. Inter Processor Interrupt (IPI) is used for communication between
different processors on ZynqMP SoC. Each IPI register set has Trigger, Status
and Observation registers for communication between processors. Each IPI path
has a 32 byte buffer associated with it and these buffers are located in the
XPPU RAM. This driver supports the following operations: - Trigger IPIs to CPUs
on the SoC - Write and Read Message buffers - Read the status of Observation
Register to get status of Triggered IPI - Enable/Disable IPIs from selected
Masters - Read the Status register to get the source of an incoming IPI
<b>Initialization</b> The config data for the driver is loaded and is based on
the HW build. The XIpiPsu_Config data structure contains all the data related to
the IPI driver instance and also the available Target CPUs. <b>Sending an
IPI</b> The following steps can be followed to send an IPI: - Write the Message
into Message Buffer using XIpiPsu_WriteMessage() - Trigger IPI using
XIpiPsu_TriggerIpi() - Wait for Ack using XIpiPsu_PollForAck() - Read response
using XIpiPsu_ReadMessage() @note XIpiPsu_GetObsStatus() before sending an IPI
to ensure that the previous IPI was serviced by the target <b>Receiving an
IPI</b> To receive an IPI, the following sequence can be followed: - Register an
interrupt handler for the IPIs interrupt ID - Enable the required sources using
XIpiPsu_InterruptEnable() - In the interrupt handler, Check for source using
XIpiPsu_GetInterruptStatus - Read the message form source using
XIpiPsu_ReadMessage() - Write the response using XIpiPsu_WriteMessage() - Ack
the IPI using XIpiPsu_ClearInterruptStatus() @note XIpiPsu_Reset can be used at
startup to clear the status and disable all sources <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- --- -------- 2.2 ms 01/23/17 Modified xil_printf
statement in main function for all examples to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
kvn 02/17/17 Add support for updating ConfigTable at run time ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. 2.3 ms 04/11/17
Modified tcl file to add suffix U for all macro definitions of ipipsu in
xparameters.h ms 03/28/17 Add index.html to provide support for importing
examples in SDK. 2.5 sdd 12/17/18 Add the cpp extern macro. </pre> /

FILES:
XilinxProcessorIPLib/drivers/ipipsu/src/xipipsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xipipsu_hw.h @addtogroup
ipipsu_v2_5 @{ This file contains macro definitions for low level HW related
params <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
-----------------------------------------------. 1.0 mjr 03/15/15 First release
2.1 kvn 05/05/16 Modified code for MISRA-C:2012 Compliance 2.5 sdd 12/17/18 Add
the cpp extern macro. </pre>

FILES:
XilinxProcessorIPLib/drivers/ipipsu/src/xipipsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xipipsu_sinit.c @addtogroup
ipipsu_v2_5 @{ The implementation of the XIpiPsu component's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.0 mjr 03/15/15 First release 2.1 kvn 05/05/16 Modified code
for MISRA-C:2012 Compliance </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ipipsu/src/xipipsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Ver Who Date Changes -------- ------
-------- 4.0 adk 10/12/13 Removed support for xps_ll_fifo 5.3 rsp 11/08/18 Fix
poll and interrupt example receive sequence i.e RDFO should be read before
reading RLR.

FILES:
XilinxProcessorIPLib/drivers/llfifo/data/llfifo.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 2.00a sdm 07/26/10 Updated to use the string
"Axi_Fifo" in canonical definitions for AxiFifo 3.00a adk 08/10/13 Added
parameters C_AXI4_BASEADDR and C_AXI4_HIGHADDR and C_DATA_INTERFACE_TYPE inorder
to support AXI4 Datainterface. 4.0 adk 12/10/13 Updated as per the New Tcl API's
5.1 adk 01/02/15 CR885653 Fix Incorrect AXI4 Base address being Exported to the
xparameters.h file. 5.2 ms 04/18/17 Modified tcl file to add suffix U for all
macros definitions of llfifo in xparameters.h

FILES:
XilinxProcessorIPLib/drivers/llfifo/data/llfifo.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xllfifo_interrupt_example.c
This file demonstrates how to use the Streaming fifo driver on the xilinx AXI
Streaming FIFO IP.The AXI4-Stream FIFO core allows memory mapped access to a
AXI-Stream interface. The core can be used to interface to AXI Streaming IPs
similar to the LogiCORE IP AXI Ethernet core, without having to use full DMA
solution. This is the interrupt example for the FIFO it assumes that at the h/w
level FIFO is connected in loopback.In these we write known amount of data to
the FIFO and wait for interrupts and after completely receiving the data
compares it with the data transmitted. Note: The TDEST Must be enabled in the
H/W design inorder to get correct RDR value. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 3.00a adk 08/10/2013 initial release CR:727787
5.1 ms 01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 04/05/17 Added tabspace for return statements in functions
for proper documentation and Modified Comment lines to consider it as a
documentation block while generating doxygen. 5.3 rsp 11/08/18 Modified TxSend
to fill SourceBuffer with non-zero data otherwise the test can return a false
positive because DestinationBuffer is initialized with zeros. In fact, fixing
this exposed a bug in FifoRecvHandler and caused the test to start failing.
According to the product guide (pg080) for the AXI4-Stream FIFO, the RDFO should
be read before reading RLR. Reading RLR first will result in the RDFO being
reset to zero and no data being received. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/llfifo/examples/xllfifo_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file XLlFifo_polling_example.c This
file demonstrates how to use the Streaming fifo driver on the xilinx AXI
Streaming FIFO IP.The AXI4-Stream FIFO core allows memory mapped access to a
AXI-Stream interface. The core can be used to interface to AXI Streaming IPs
similar to the LogiCORE IP AXI Ethernet core, without having to use full DMA
solution. This is the polling example for the FIFO it assumes that at the h/w
level FIFO is connected in loopback.In these we write known amount of data to
the FIFO and Receive the data and compare with the data transmitted. Note: The
TDEST Must be enabled in the H/W design inorder to get correct RDR value. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 3.00a adk
08/10/2013 initial release CR:727787 5.1 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Added tabspace for return statements in functions for proper documentation and
Modified Comment lines to consider it as a documentation block while generating
doxygen. 5.3 rsp 11/08/18 Modified TxSend to fill SourceBuffer with non-zero
data otherwise the test can return a false positive because DestinationBuffer is
initialized with zeros. In fact, fixing this exposed a bug in RxReceive and
caused the test to start failing. According to the product guide (pg080) for the
AXI4-Stream FIFO, the RDFO should be read before reading RLR. Reading RLR first
will result in the RDFO being reset to zero and no data being received. </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/llfifo/examples/xllfifo_polling_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xllfifo.c @addtogroup
llfifo_v5_3 @{ The Xilinx local link FIFO driver component. This driver supports
the Xilinx xps_ll_fifo core. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jvb 10/13/06 First release 1.00a xd 12/17/07 Added
type casting to fix CR 456850 1.02a jz 12/04/09 Hal phase 1 support 2.00a hbm
01/20/10 Hal phase 1 support, bump up major release 2.01a asa 09/17/10 Added
code for resetting Streaming interface for CR574868 3.00a adk 08/10/13 Added
support for AXI4 Datainterface.Updated XLlFifo_RxGetWord, XLlFifo_TxPutword
inorder to handle AXI4 Datainterface. Added Config initialization for the
driver. 5.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425.
Changed the prototypes of XLlFifo_CfgInitialize, XLlFifo_Initialize APIs. </pre>
/ Include Files /

FILES:
XilinxProcessorIPLib/drivers/llfifo/src/xllfifo.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xllfifo.h @addtogroup
llfifo_v5_3 @{ @details The Xilinx Dual Channel Fifo driver component. This
driver supports the Virtex-5(TM) and Virtex-4(TM) XPS_ll_Fifo and the AxiFifo.
For a full description of the bridge features, please see the HW spec. This
driver supports the following features: - Memory mapped access to host interface
registers - API for polled frame transfers - API for interrupt driven frame
transfers - Virtual memory support - Full duplex operation <h2>Driver
Description</h2> This driver enables higher layer software to access the
XPS_llFifo core using any alignment in the data buffers. This driver supports
send and receive channels in the same instance structure in the same fashion as
the hardware core. <h2>Initialization</h2> An instance of this driver is
initialized using a call to Initialize(). <h2>Usage</h2> It is fairly simple to
use the API provided by this FIFO driver. The only somewhat tricky part is that
the calling code must correctly call a couple routines in the right sequence for
receive and transmit. This sequence is described here. Check the routine
functional descriptions for information on how to use a specific API routine.
<h3>Receive</h3> A frame is received by using the following sequence:<br> 1)
call XLlFifo_iRxGetLen() to get the length of the incoming frame<br> 2) call
XLlFifo_RxGetWord() one or more times to read the number of bytes reported by
the hardware<br> 3) call XLlFifo_iRxOccupancy() to know the availability of the
data in the FIFO.<br> For example: <pre> ReceiveLength
(XLlFifo_iRxGetLen(InstancePtr))/WORD_SIZE; for ( i0; i < ReceiveLength; i++){
RxWord XLlFifo_RxGetWord(InstancePtr); do something here with the data
if(XLlFifo_iRxOccupancy(InstancePtr)){ RxWord XLlFifo_RxGetWord(InstancePtr); }
} </pre> This FIFO hardware core does <b>not</b> support a sequence where the
calling code calls iRxGetLen() twice in a row and then receive the data for two
frames. Each frame must be read in by calling iRxGetLen() just prior to reading
the data. <h3>Transmit</h3> A frame is transmittted by using the following
sequence:<br> 1) XLlFifo_iTxVacancy() one or more times to know the availability
of unused 32-bit words in the FIFO channel.<br> 2) call XLlFifo_TxPutWord() one
or more times to write all the of bytes in the next frame.<br> 3) call
XLlFifo_iTxSetLen() to begin the transmission of frame just written.<br> For
example: <pre> for (j0 ; j < MAX_PACKET_LEN ; j++){ if(
XLlFifo_iTxVacancy(InstancePtr) ){ XLlFifo_TxPutWord(InstancePtr,
(SourceAddr+(iMAX_PACKET_LEN)+j)); } } XLlFifo_iTxSetLen(InstancePtr,
(MAX_DATA_BUFFER_SIZE WORD_SIZE)); </pre> This FIFO hardware core does
<b>not</b> support a sequence where the calling code writes the data for two
frames and then calls iTxSetLen() twice in a row. Each frame must be written by
writing the data for one frame and then calling iTxSetLen(). <h2>Interrupts</h2>
This driver does not handle interrupts from the FIFO hardware. The software
layer above may make use of the interrupts by setting up its own handlers for
the interrupts. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a jvb 10/12/06 First release 1.01a sdm 08/22/08 Removed support for
static interrupt handlers from the MDD file 1.02a jz 12/04/09 Hal phase 1
support 2.01a asa 09/17/10 Added code for resetting Local Link/AXI Streaming
interface for CR574868 2.02a asa 12/27/11 Changed the function XStrm_Read in
xtreamer.c to reset HeadIndex to zero when all bytes have been read. Changed the
macro XStrm_IsRxInternalEmpty in file xtreamer.h to use FrmByteCnt instead of
HeadIndex. When FrmByteCnt is zero, this means all internal buffers in streamer
are empty. Earlier implementation using HeadIndex was not very clear and could
give improper results for some cases. Changed the macro XLlFifo_IsRxEmpty in
file xllfifo.h These changes are done to fix the CR 604650. 2.03a asa 14/08/12
Added XLLF_TDR_OFFSET, XLLF_RDR_OFFSET defines for the new registers, and
XLLF_INT_TFPF_MASK, XLLF_INT_TFPE_MASK, XLLF_INT_RFPF_MASK and
XLLF_INT_RFPE_MASK for the new version of the AXI4-Stream FIFO core (v2.01a and
later) 3.00a adk 08/10/13 Added support for AXI4 Datainterface.Changes are In
Xllfifo.c file XLlFifo_RxGetWord,XLlFifo_TxPutword. In XLlfifo.h file updated
XLlfifo structure for Axi4BaseAddress and for Datainterface type provided
polling and interrupt examples. XLlfifo_IsRxDone Macro Is added in the XLlfifo.h
file for polledmode example. Added Static initialization for the driver.
XLlFifo_Initialize is still used to make the driver backward compatible. 4.0 adk
19/12/13 Updated as per the New Tcl API's 5.0 adk 15/05/15 Updated the register
offsets in the AXI4 data path as per latest IP version(v4.1)(CR:860254). 5.1 sk
11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototypes of XLlFifo_CfgInitialize, XLlFifo_Initialize APIs. 5.1 adk 01/02/15
CR885653 Fix Incorrect AXI4 Base address being Exported to the xparameters.h
file. ms 01/23/17 Modified xil_printf statement in main function for all
examples to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/05/17 Added tabspace for return
statements in functions for proper documentation and Modified Comment lines to
consider it as a documentation block while generating doxygen for llfifo
examples. 5.2 ms 04/18/17 Modified tcl file to add suffix U for all macros
definitions of llfifo in xparameters.h 5.2 adk 03/07/17 CR978769 Fix doxygen
issues in the driver. Updated comments in the usage section as per example code.
Fix doxygen warnings in the driver. </pre> /

FILES:
XilinxProcessorIPLib/drivers/llfifo/src/xllfifo.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xllfifo_g.c @addtogroup
llfifo_v5_3 @{ Provide a template for user to define their own hardware
settings. If using XPS, this file will be automatically generated. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 3.00a adk
9/10/2013 initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/llfifo/src/xllfifo_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xllfifo_hw.h @addtogroup
llfifo_v5_3 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the xps_ll_fifo core. High-
level driver functions are defined in xpfifo.h. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a jvb 10/16/06 First release. 1.02a jz
12/04/09 Hal phase 1 support 2.00a hbm 01/20/10 Hal phase 1 support, bump up
major release 2.03a asa 14/08/12 Added XLLF_TDR_OFFSET, XLLF_RDR_OFFSET defines
for the new registers, and XLLF_INT_TFPF_MASK, XLLF_INT_TFPE_MASK,
XLLF_INT_RFPF_MASK and XLLF_INT_RFPE_MASK for the new version of the AXI4-Stream
FIFO core (v2.01a and later) </pre>

FILES:
XilinxProcessorIPLib/drivers/llfifo/src/xllfifo_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xllfifo_sinit.c @addtogroup
llfifo_v5_3 @{ This file contains static initialization functionality for Axi
Streaming FIFO driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 3.00a adk 9/10/2013 initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/llfifo/src/xllfifo_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xstreamer.c @addtogroup
llfifo_v5_3 @{ See xtreamer.h for a description on how to use this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jvb
10/13/06 First release - based on Robert McGee's streaming packet fifo driver.
1.02a jz 12/04/09 Hal phase 1 support 2.00a hbm 01/20/10 Hal phase 1 support,
bump up major release 2.02a asa 12/28/11 The function XStrm_Read is changed to
reset HeadIndex to zero when all the bytes are read. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/llfifo/src/xstreamer.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xstreamer.h @addtogroup
llfifo_v5_3 @{ The Xilinx byte streamer for packet FIFOs. <h2>Driver
Description</h2> This driver enables higher layer software to access a hardware
FIFO using any alignment in the data buffers while preserving alignment for the
hardware FIFO access. This driver treats send and receive channels separately,
using different types of instance objects for each. This driver makes use of
another FIFO driver to access the specific FIFO hardware through use of the
routines passed into the Tx/RxInitialize routines. <h2>Initialization</h2> Send
and receive channels are initialized separately. The receive channel is
initiailzed using XStrm_RxInitialize(). The send channel is initialized using
XStrm_TxInitialize(). <h2>Usage</h2> It is fairly simple to use the API provided
by this byte streamer driver. The only somewhat tricky part is that the calling
code must correctly call a couple routines in the right sequence for receive and
transmit. This sequence is described here. Check the routine functional
descriptions for information on how to use a specific API routine.
<h3>Receive</h3> A frame is received by using the following sequence:<br> 1)
call XStrm_RxGetLen() to get the length of the next incoming frame.<br> 2) call
XStrm_Read() one or more times to read the number of bytes reported by
XStrm_RxGetLen().<br> For example: <pre> frame_len XStrm_RxGetLen(&RxInstance);
while (frame_len) { unsigned bytes min(sizeof(buffer), frame_len);
XStrm_Read(&RxInstance, buffer, bytes); do something with buffer here frame_len
- bytes; } </pre> Other restrictions on the sequence of API calls may apply
depending on the specific FIFO driver used by this byte streamer driver.
<h3>Transmit</h3> A frame is transmittted by using the following sequence:<br>
1) call XStrm_Write() one or more times to write all the of bytes in the next
frame.<br> 2) call XStrm_TxSetLen() to begin the transmission of frame just
written.<br> For example: <pre> frame_left frame_len; while (frame_left) {
unsigned bytes min(sizeof(buffer), frame_left); XStrm_Write(&TxInstance, buffer,
bytes); do something here to refill buffer } XStrm_TxSetLen(&RxInstance,
frame_len); </pre> Other restrictions on the sequence of API calls may apply
depending on the specific FIFO driver used by this byte streamer driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jvb
10/12/06 First release 1.02a jz 12/04/09 Hal phase 1 support 2.00a hbm 01/20/10
Hal phase 1 support, bump up major release 2.02a asa 12/28/11 The macro
XStrm_IsRxInternalEmpty is changed to use FrmByteCnt instead of HeadIndex.
</pre> /

FILES:
XilinxProcessorIPLib/drivers/llfifo/src/xstreamer.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @BEGIN_CHANGELOG EDK_MS3 07/25/10 sdm
removed support for opb_mailbox @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/mbox/data/mbox.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 3.01a sdm 05/06/10 Updated to support AXI
common::version of the core 3.02a bss 08/18/12 Updated the script to fix CR
655224 and CR 672073. Added check for C_USE_EXTENDED_FSL_INSTR for AXI Stream.
3.02a bss 12/03/12 Updated the script to fix CR687103 and CR688715 4.1 sk
11/09/15 Removed delete filename statement CR 784758. 4.2 ms 04/18/17 Modified
tcl file to add suffix U for all macros definitions of mbox in xparameters.h 4.3
sd 07/26/17 Modified tcl file to prevent false unconnected flagging. uses
"xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/mbox/data/mbox.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @BEGIN_CHANGELOG EDK_K_SP2 - Initial
Revision @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/mbox/data/mbox_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox_example.c This file
contains a design example for using the Mailbox hardware and driver XMbox The
example assumes there are two processors availabile in the system that are
expected to inter-communicate. This example has been tested on ML505 Hardware
Evaluation board. @note These code fragments will illustrate how the XMbox
component can be used to: - Initialize the Mailbox core - Pass data between two
processes <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a va First release 1.00a ecm 06/09/07 Cleanup, new coding standard, check
into XCS 3.01a sdm 05/06/10 Cleanup for coding guidelines 4.1 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 04/10/17 Modified filename tag to include the file in doxygen examples.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mbox/examples/xmbox_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox_intr_example.c This file
contains a design example for using the Mailbox hardware and driver XMbox. This
example attempts to send a known message through the mailbox from the processor
identified as 0 (XPAR_CPU_ID0) to the other processor. The message is received
by the receiver and the test passes. Since the application is running on two
seperate processors, the initiator declares success when the message is sent and
the receiver declares success when the message is received. There is no feedback
to the initiator so a terminal is required for each processor to verify that the
test passed for both sides. The example assumes there are two processors
availabile in the system that are expected to inter-communicate. This example
has been tested on ML505 Hardware Evaluation board. @note These code fragments
will illustrate how the XMbox component can be used to: - Initialize the Mailbox
core. - pass data between two processors. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 2.00a hm Example that sends and receives and
uses interrupts 3.01a sdm 05/06/10 Cleanup for coding guidelines, removed
printfs from all the functions except the main function 4.1 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen and modified filename tag to include the
file in doxygen examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mbox/examples/xmbox_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox_tapp_example.c This file
contains a design example for using the Mailbox hardware and driver XMbox This
example attempts to send a known message through the mailbox from the processor
identified as 0 (XPAR_CPU_ID0) to the other processor. The message is received
by the receiver and the test passes. Since the application is running on two
seperate processors, the initiator declares success when the message is sent and
the receiver declares success when the message is received. There is no feedback
to the initiator so a terminal is required for each processor to verify that the
test passed for both sides. The example assumes there are two processors
availabile in the system that are expected to inter-communicate. If Mailbox is
connected to only one Processor then Data has to be sent from one port and
should be received from another port. This example has been tested on ML505
Hardware Evaluation board. @note These code fragments will illustrate how the
XMbox component can be used to: - Initialize the Mailbox core - pass data
between two processors. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a va First release 1.00a ecm 06/09/07 Cleanup, new coding
standard, check into XCS 1.01a ecm 08/28/08 converted to testapp example 1.01a
ecm 10/28/08 corrected output to match the requirements for TestApp integration.
2.00a hm 04/09/09 Added receiving data from the other processor. 3.01a sdm
05/06/10 Cleanup for coding guidelines and removed printfs 4.1 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mbox/examples/xmbox_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox.c @addtogroup mbox_v4_3
@{ Contains required functions for the XMbox driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a va First release 1.00a ecm
06/01/07 Cleanup, new coding standard, check into XCS 1.01a ecm 08/19/08 Fixed
the receive routine, FSL leg, was using SendID instead of the correct RecvID.
Fixed CRs 466320, 466322, 476535, 476242, 476243 new rev 2.00a hm 04/09/09 Added
support for mailbox v2.0, which has interrupts; Fixed CR 502464, which removed
extra definitions that are not associated with the interface. Fixed the
canonical definition so that each interface is considered as a device instance.
3.00a hbm 10/19/09 Migrated to HAL phase 1 to use xil_io. Removed _m from the
function names. Renamed _mIsEmpty to _IsEmptyHw and _mIsFull to _IsFullHw. 3.02a
bss 08/18/12 Added XMbox_GetStatus API for CR 676187 4.1 sk 11/10/15 Used
UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototypes of
XMbox_CfgInitialize API. 4.3 sa 04/20/17 Support for FIFO reset using hardware
control register. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mbox/src/xmbox.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox.h @addtogroup mbox_v4_3
@{ @details The Xilinx mailbox driver. This driver supports the Xilinx Mailbox
device. More detailed description of the driver operation can be found in the
xmbox.c file. - The Xilinx Mailbox is intended to be used as a bi-directional
communication core between a pair of processors. The mailbox API shall allow
software to send messages in a FIFO fashion, where the receiver is intended to
be software on another processor. - The mailbox implementation provides for a
way to "send" and "receive" in an atomic fashion using seperate FIFOs in the
mailbox core. - The API itself does not stop the use case where there is more
than one sender on the transmit side and more than one receiver on the receiving
side (just like TCP/IP sockets). However, unless there is a protocol implemented
in the messages being transferred, it is typically good practice to assign just
one transmit processor and one receiver processor to a single mailbox. - The API
provides for both blocking and non-blocking semantics on the send and receive
operations. <b>Initialization & Configuration</b> The XMbox_Config structure is
used by the driver to configure itself. This configuration structure is
typically created by the tool-chain based on HW build properties. -
XMbox_LookupConfig(DeviceId) - Use the device identifier to find the static
configuration structure defined in XMbox_g.c. This is setup by the tools. For
some operating systems the config structure will be initialized by the software
and this call is not needed. This function returns the CfgPtr argument used by
the CfgInitialize function described below. - XMbox_CfgInitialize(InstancePtr,
CfgPtr, EffectiveAddress) - Uses a configuration structure provided by the
caller. If running in a system with address translation, the provided virtual
memory base address replaces the physical address present in the configuration
structure. The EffectiveAddress argument is required regardless of operating
system environment, i.e. in standalone, CfgPtr->BaseAddress is recommended, not
the xparameters.h define. <b>Interrupts</b> The Mailbox hardware has two
interrupt outputs, one for each interface. For an interface that uses Direct FSL
the associated interrupt pin shall be high while there is data in the FIFO for
this interface. For a PLB interface there shall be 3 associated interrupt
sources that can be controlled through dedicated registers. Each of these
sources shall be associated with a specific bit position in the related
register. The sources shall be: Send Threshold Interrupt (STI), Receive
Threshold Interrupt (RTI) and FIFO Error (ERR). RTI is set when the number of
entries in the receive FIFO become greater than the RIT value (rising edge on
RTA). STI is set when the number of entries in the send FIFO becomes equal or
less than the SIT value (rising edge on STA). RTI and STI are only set when
their respective conditions goes from false to true, not continuously when the
condition is fulfilled. The Mailbox driver does not have an interrupt service
routine. It is the responsibility of the caller of Mailbox functions to manage
the interrupt including connecting to the interrupt and enabling/disabling the
interrupt. The user can create a handler to service the interrupts generated by
the Mailbox IP. Using the Blocking version of the Read function is not
recommended since the processor will hang until the requested length is
received, which might be quite a long time. @note This driver is intended to be
RTOS and processor independent. It works with physical addresses only. Any needs
for dynamic memory management, threads or thread mutual exclusion, virtual
memory, or cache control must be satisfied by the layer above this driver.
Possible Optimization technique: If the interface for the hardware is only
expected to be the memory mapped or the FSL interface for the lifetime of the
project, it is reasonable to remove the other, unused, leg through the functions
which allow access to the other interface method, i.e. if FSL is the only
available interface the memory mapped clause in the if statements can be removed
improving the performance some due to the lack of the test and branch. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a va First
release 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS
Converted to new XPS hardware. 1.01a ecm 08/19/08 Fixed CRs 466320, 466322,
476535, 476242, 476243 new rev 2.00a hm 04/09/09 Added support for mailbox v2.0,
which has interrupts Fixed CR 502464, which removed extra definitions that are
not associated with the interface. Fixed the canonical definition so that each
interface is considered as a device instance. 3.01a sdm 05/06/10 New driver to
support AXI version of the core and cleaned up for coding guidelines. 3.02a bss
08/18/12 Updated tcl script to support Zynq system and AXI stream interface for
CR 672073 and CR 655224 respectively. Added XMbox_GetStatus API for CR 676187
3.03a bss 01/30/13 Updated driver tcl to fix CR687103 and CR688715 3.04a bss
05/13/13 Updated test app tcl to display message that Peripheral tests will not
be run if there is only one Processor in design CR715626 4.0 adk 19/12/13
Updated as per the New Tcl API's 4.1 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototypes of XMbox_CfgInitialize API. ms
01/23/17 Modified xil_printf statement in main function for all examples to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/05/17 Added tabspace for return
statements in functions of mbox examples for proper documentation while
generating doxygen and modified filename tag to include them in doxygen
examples. 4.2 ms 04/18/17 Modified tcl file to add suffix U for all macros
definitions of mbox in xparameters.h ms 08/07/17 Fixed compilation warnings in
xmbox_sinit.c 4.3 sa 04/20/17 Support for FIFO reset using hardware control
register. sd 07/26/17 Modified tcl file to prevent false unconnected flagging.
</pre>

FILES:
XilinxProcessorIPLib/drivers/mbox/src/xmbox.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox_g.c @addtogroup mbox_v4_3
@{ This file contains a configuration table that specifies the configuration of
Mbox devices in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a ecm 06/01/07 Cleanup, new coding standard, check into
XCS </pre> @note None. Include Files /

FILES:
XilinxProcessorIPLib/drivers/mbox/src/xmbox_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox_hw.h @addtogroup
mbox_v4_3 @{ This header file contains identifiers and driver macros that can be
used to access the device. The user should refer to the hardware device
specification for more details of the device operation. The driver
functions/APIs are defined in xmbox.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a va First release 1.00a ecm 06/01/07 Cleanup,
new coding standard, check into XCS 1.00a ecm 08/19/08 Fixed CRs 466320, 466322,
476535, 476242, 476243 new rev 2.00a hm 04/09/09 Added support for mailbox v2.0,
which has interrupts. Fixed CR 502464, which removed extra definitions that are
not associated with the interface. Fixed the canonical definition so that each
interface is considered as a device instance. 3.00a hbm 10/19/09 Migrated to HAL
phase 1 to use xil_io. Removed _m from the function names. Renamed _mIsEmpty to
_IsEmptyHw and _mIsFull to _IsFullHw. 4.3 sa 04/20/17 Added CTRL register
definitions. </pre>

FILES:
XilinxProcessorIPLib/drivers/mbox/src/xmbox_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmbox_sinit.c @addtogroup
mbox_v4_3 @{ Implements static initialization See xmbox.h for more information
about the component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 4.2 ms
08/07/17 Fixed compilation warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mbox/src/xmbox_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 adk 18/07/17 First release 1.1 adk 09/02/18
Updated tcl logic to export proper values for CACHE_COHERENT properties when h/w
is configured for single axi4 data interface. Added failure checks in the tcl to
avoid bsp compilation errors in case stream interface is unconnected. 1.2 rsp
09/07/18 Pass "hier" argument to get_cells API to support hierarchical designs.
1.3 rsp 02/05/19 Enable CCI only at EL1 non-secure state. rsp 02/12/19 Export
use RxLength field. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/mcdma/data/mcdma.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma_interrupt_example.c This
file demonstrates how to use the mcdma driver on the Xilinx AXI MCDMA core (AXI
MCDMA) to transfer packets in interrupt mode. This examples shows how to do
multiple packets and multiple BD's Per packet transfers. H/W Requirements: In
order to test this example at the design level AXI MCDMA MM2S should be
connected with the S2MM channel. System level Considerations for Zynq
UltraScale+ designs: Please refer xmcdma_polled_example.c file. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 adk 18/07/17
Initial Version. 1.2 rsp 07/19/18 Read channel count from IP config. Fix gcc
'pointer from integer without a cast' warning. rsp 08/17/18 Fix typos and
rephrase comments. rsp 08/17/18 Read Length register value from IP config. 1.3
rsp 02/05/19 Remove snooping enable from application. rsp 02/06/19
Programmatically select cache maintenance ops for HPC and non-HPC designs. In Rx
remove arch64 specific dsb instruction by performing cache invalidate operation
for all supported architectures. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/mcdma/examples/xmcdma_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma_polled_example.c This
file demonstrates how to use the mcdma driver on the Xilinx AXI MCDMA core (AXI
MCDMA) to transfer packets in polling mode. This examples shows how to do
multiple packets and multiple BD's per packet transfers. H/W Requirements: In
order to test this example at the h/w level AXI MCDMA MM2S should be connected
to the S2MM channel. System level considerations for Zynq UltraScale+ designs:
On ZU+ MPSOC for PL IP's 3 different ports are available HP, HPC and ACP. The
explanation below talks about HPC and HP port. HPC design considerations: ZU+
MPSOC has in-built cache coherent interconnect(CCI) to take care of Coherency
through HPC port. CCI is only support at EL1 NS level. Following needs to be
done by the system components before running the example 1) Snooping should be
enabled in the S3 (0xFD6E4000) 2) Mark the DDR memory being used for buffers as
outer-shareable. translation_table.S. .set Memory, 0x405 | (2 << 8) | (0x0). It
is recommended to use HPC to make use of H/W coherency feature. HP design
considerations: The example uses un-cached memory for buffer descriptors and
uses Normal memory for buffers.. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 adk 18/07/2017 Initial Version. 1.2 rsp
07/19/2018 Read channel count from IP config. rsp 08/17/2018 Fix typos and
rephrase comments. rsp 08/17/2018 Read Length register value from IP config. 1.3
rsp 02/05/2019 Remove snooping enable from application. rsp 02/06/2019
Programmatically select cache maintenance ops for HPC and non-HPC designs. In Rx
remove arch64 specific dsb instruction by performing cache invalidate operation
for all supported architectures. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/mcdma/examples/xmcdma_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma.c @addtogroup mcdma_v1_3
@{ This file contains the implementation of the interface functions for MCDMA
driver. Refer to the header file xmcdma.h for more detailed information.
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 adk
18/07/17 Initial version. 1.1 rsp 20/02/18 Fix unused variable warning. Remove
TimeOut variable.CR-979061 1.3 rsp 14/02/19 Populate HasRxLength value from
config. Include Files /

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma.h @addtogroup mcdma_v1_3
@{ @details AXI MultiChannel Direct Memory Access (AXI MDMA) IP provides high-
bandwidth Direct memory access between the AXI4 memory mapped and AXI4-Stream IP
interfaces. Its scatter gather capabilities also offload data Movement tasks
from the Central Processing Unit (CPU) in processor-based Systems. In AXI MCDMA
Primary high-speed DMA data movement between system memory and Stream target is
through the AXI4 Read Master to AXI4 memory-mapped to Stream (MM2S) Master, and
AXI stream to memory-mapped (S2MM) Slave to AXI4 Write Master. AXI DMA enables
up to 16 multiple channels of data movement on both MM2S and S2MM paths.
<b>Initialization & Configuration</b> The device driver enables higher layer
software (e.g., an application) to communicate to the AXI MCDMA IP core.
XMcDma_CfgInitialize() API is used to initialize the MCDMA core. The user needs
to first call the XMcDma_LookupConfig() API which returns the Configuration
structure pointer which is passed as a parameter to the XMcDma_CfgInitialize()
API. <b> Interrupts </b> In single interrupt multiple channels case driver
provides interrupt handler XMcdma_TxIntrHandler and XMcdma_IntrHandler for mm2s
and s2mm side respectively for handling the interrupt from the MCDMA core. The
users of this driver have to register this handler with the interrupt system and
provide the callback functions by using XMcdma_SetCallBack API. <b>Buffer
Descriptors(BD) management </b> BD is shared by the software and the hardware.
To use BD for SG DMA transfers, the application needs to use the driver API to
do the following: - Setup the BD's for the Channel: - XMcDma_ChanBdCreate(...) -
Submit a DMA transfer for the required length. - XMcDma_ChanSubmit(...) - Submit
all prepared BDs to the hardware: - XMcDma_ChantoHw(...) - Upon transfer
completion, the application can request completed BDs from the hardware: -
XMcdma_BdChainFromHW(...) - After the application has finished using the BDs, it
should free the BDs back to the free pool: - XMcdma_BdChainFree(...) The driver
also provides API functions to get the status of a completed BD, along with get
functions for other fields in the BD. The following diagram shows the correct
flow of BDs: The diagram shows a complete cycle for BDs, starting from
requesting the BDs to freeing the BDs. <pre> XMcDma_ChanSubmit()
XMcDma_ChanToHw() Free ---------------------- Pre-process --------------------
Hardware | /|\ | | XMcdma_BdChainFree() XMcdma_BdChainFromHW() |
+--------------------------- Post-process <----------------------+ </pre> <b>
Virtual Memory </b> This driver supports Virtual Memory. The RTOS is responsible
for calculating the correct device base address in Virtual Memory space. <b>
Threads </b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver. <b> Asserts
</b> Asserts are used within all Xilinx drivers to enforce constraints on
argument values. Asserts can be turned off on a system-wide basis by defining,
at compile time, the NDEBUG identifier. By default, asserts are turned on and it
is recommended that users leave asserts on during development. <b> Building the
driver </b> The AXI MCDMA driver is composed of several source files. This
allows the user to build and link only those parts of the driver that are
necessary. This header file contains identifiers and register-level driver
functions (or macros), range macros, structure typedefs that can be used to
access the Xilinx AXI MCDMA core instance. MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 adk 18/07/17 Initial version. 1.0 adk 09/02/18
Fixed CR994435 Changes are made in the driver tcl file. 1.2 mj 05/03/18 Exported
APIs XMcdma_BdChainFree() and XMcDma_BdSetAppWord(). 1.2 mus 11/05/18 Support 64
bit DMA addresses for Microblaze-X platform. 1.3 rsp 02/12/19 Add HasRxLength
field in config and channel structure. 1.3 rsp 02/11/19 Add top level submit
XMcDma_Chan_Sideband_Submit() API to program BD control and sideband
information.

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma_bd.c @addtogroup
mcdma_v1_3 @{ This file implements all the Scatter/Gather handling for the MCDMA
Core, please see xmcdma.h for more details. MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 adk 18/07/17 Initial Version. 1.2 mus 11/05/18
Support 64 bit DMA addresses for Microblaze-X platform. 1.3 rsp 02/11/19 Add top
level submit XMcDma_Chan_Sideband_Submit() API to program BD control and
sideband information.

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma_bd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma_bd.h @addtogroup
mcdma_v1_3 @{ MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
adk 18/07/17 Initial version. 1.2 mj 05/03/18 Added macro XMcdma_BdSetSwId and
XMcdma_BdGetSwId to set and get Sw ID field from BD.

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma_bd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.0 adk 18/07/17 Initial version. 1.2 mj 05/03/18
Defined XMCDMA_BD_SW_ID_OFFSET 1.2 rsp 08/17/18 Remove unused XMCDMA_BD_LEN_MASK

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma_intr.c @addtogroup
mcdma_v1_3 @{ This file contains the implementation of the interrupt handling
functions for MCDMA driver. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 adk 18/07/17 Initial version. Include Files /

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma_selftest.c @addtogroup
mcdma_v1_3 @{ This file contains the self-test function for the MCDMA core.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 adk
18/07/17 Initial version. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmcdma_sinit.c @addtogroup
mcdma_v1_3 @{ This file contains static initialization methods for Xilinx MCDMA
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0
adk 18/07/17 Initial version. 1.2 mj 05/03/18 Implemented
XMcdma_LookupConfigBaseAddr() to lookup configuration based on base address.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mcdma/src/xmcdma_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 adk 01/08/16 Initial uses "xillib_sw.tcl"

FILES:
XilinxProcessorIPLib/drivers/mig/data/mig.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmig.h @addtogroup mig_v1_0 @{
@details This driver exists only to allow the SDK tools to create a memory test
application and to populate xparameters.h with memory range constants. There is
no source code. VER WHO DATE Changes 1.0 adk 01/08/16 Initial version @} /

FILES:
XilinxProcessorIPLib/drivers/mig/src/xmig.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 2.0 adk 12/10/13 Updated as per the New Tcl
API's 2.0 bss 03/04/14 Modified to generate WIDTH parameters.CR 717423 2.1 ms
04/18/17 Modified tcl file to add suffix U for all macros definitions of
mig_7series in xparameters.h uses "xillib_sw.tcl"

FILES:
XilinxProcessorIPLib/drivers/mig_7series/data/mig_7series.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmig_7series.h @addtogroup
mig_7series_v2_1 @{ @details This driver exists only to allow the SDK tools to
create a memory test application and to populate xparameters.h with memory range
constants. There is no source code. VER WHO DATE Changes 2.0 adk 19/12/13
Updated as per the New Tcl API's 2.1 ms 04/18/17 Modified tcl file to add suffix
U for all macros definitions of mig_7series in xparameters.h @} /

FILES:
XilinxProcessorIPLib/drivers/mig_7series/src/xmig_7series.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes --- --- -------- 1.0 vsa 07/21/15 Initial version of subsystem tcl 1.1
vsa 08/31/17 Fix for IP with different name

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/data/mipicsiss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss_intr_example.c This file
contains a design example using the XCsiSs driver with interrupts. On receiving
a frame received interrupt, it will print frames received count. On receiving a
short packet FIFO not empty interrupt, it will print the contents of the short
packet received. On receiving DPHY, protocol or Packet level error, it will
print the same On receiving any type of error interrupt the sub-system will
reset @note This example requires an interrupt controller connected to the
processor and the MIPI CSI Rx Subsystem in the system. The Camera Sensor may
need some programming before via the IIC before it starts to send any video
stream. For this example to display output, the user need to implement
initialization of the system (CsiSs_PlatformInit) and after MIPI CSI Rx
subsystem start (XCsiSs_Start) is complete, implement configuration of the video
stream source in order to provide the MIPI CSI Rx Subsystem HIP input. The
functions CsiSs_PlatformInit and CsiSs_StreamSrc are declared and are left up to
the user implement. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
-------- 1.0 vsa 07/21/15 Initial release 1.1 ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. 1.2 vsa
03/02/17 Added Word Count corruption interrupt </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xcsiss_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss_selftest_example.c This
file contains a design example using the XCsiSs driver. It performs a self test
on the MIPI CSI Rx Subsystem that will test its sub-cores self test functions.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------
1.0 vsa 07/29/15 Initial release 1.1 ms 01/23/17 Modified xil_printf statement
in main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xcsiss_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / DP159 Written by Marco Groeneveld
(c) 2014, 2015 by Xilinx Inc. History v1.0 - Initial release v1.1 - Updated
DP159 setting to automatic redriver to retimer for HDMI 1.4 data rates /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/dp159.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/dp159.h
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/platform.c
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/platform.h
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/platform_config.h
XilinxProcessorIPLib/drivers/rfdc/examples/xrfdc_clk.h
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/platform.c
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/platform.h
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/platform_config.h
lib/sw_apps/versal_psmfw/src/xpsmfw_api.c
lib/sw_apps/versal_psmfw/src/xpsmfw_api.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/bspconfig.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102/bspconfig.h
lib/sw_apps/zynqmp_pmufw/misc/bspconfig.h
lib/sw_apps/zynqmp_pmufw/misc/xemacps_g.c
lib/sw_apps/zynqmp_pmufw/misc/xfpga_config.h
lib/sw_apps/zynqmp_pmufw/misc/xgpiops_g.c
lib/sw_apps/zynqmp_pmufw/misc/xiicps_g.c
lib/sw_apps/zynqmp_pmufw/misc/xqspipsu_g.c
lib/sw_apps/zynqmp_pmufw/misc/xsdps_g.c
lib/sw_apps/zynqmp_pmufw/misc/xttcps_g.c
lib/sw_apps/zynqmp_pmufw/misc/xusbpsu_g.c
lib/sw_apps/zynqmp_pmufw/src/efuse.h
lib/sw_apps/zynqmp_pmufw/src/pm_binding.c
lib/sw_apps/zynqmp_pmufw/src/pm_callbacks.c
lib/sw_apps/zynqmp_pmufw/src/pm_clock.c
lib/sw_apps/zynqmp_pmufw/src/pm_clock.h
lib/sw_apps/zynqmp_pmufw/src/pm_config.c
lib/sw_apps/zynqmp_pmufw/src/pm_core.c
lib/sw_apps/zynqmp_pmufw/src/pm_csudma.c
lib/sw_apps/zynqmp_pmufw/src/pm_csudma.h
lib/sw_apps/zynqmp_pmufw/src/pm_ddr.c
lib/sw_apps/zynqmp_pmufw/src/pm_extern.c
lib/sw_apps/zynqmp_pmufw/src/pm_extern.h
lib/sw_apps/zynqmp_pmufw/src/pm_gic_proxy.c
lib/sw_apps/zynqmp_pmufw/src/pm_gic_proxy.h
lib/sw_apps/zynqmp_pmufw/src/pm_gpp.c
lib/sw_apps/zynqmp_pmufw/src/pm_hooks.c
lib/sw_apps/zynqmp_pmufw/src/pm_hooks.h
lib/sw_apps/zynqmp_pmufw/src/pm_master.c
lib/sw_apps/zynqmp_pmufw/src/pm_mmio_access.c
lib/sw_apps/zynqmp_pmufw/src/pm_mmio_access.h
lib/sw_apps/zynqmp_pmufw/src/pm_node.c
lib/sw_apps/zynqmp_pmufw/src/pm_node_reset.c
lib/sw_apps/zynqmp_pmufw/src/pm_notifier.c
lib/sw_apps/zynqmp_pmufw/src/pm_periph.c
lib/sw_apps/zynqmp_pmufw/src/pm_periph.h
lib/sw_apps/zynqmp_pmufw/src/pm_pinctrl.c
lib/sw_apps/zynqmp_pmufw/src/pm_pinctrl.h
lib/sw_apps/zynqmp_pmufw/src/pm_pll.c
lib/sw_apps/zynqmp_pmufw/src/pm_power.c
lib/sw_apps/zynqmp_pmufw/src/pm_proc.c
lib/sw_apps/zynqmp_pmufw/src/pm_qspi.c
lib/sw_apps/zynqmp_pmufw/src/pm_qspi.h
lib/sw_apps/zynqmp_pmufw/src/pm_requirement.c
lib/sw_apps/zynqmp_pmufw/src/pm_reset.c
lib/sw_apps/zynqmp_pmufw/src/pm_slave.c
lib/sw_apps/zynqmp_pmufw/src/pm_sram.c
lib/sw_apps/zynqmp_pmufw/src/pm_system.c
lib/sw_apps/zynqmp_pmufw/src/pm_usb.c
lib/sw_apps/zynqmp_pmufw/src/xpfw_module.h
lib/sw_apps/zynqmp_pmufw/src/xpfw_rom_interface.c
lib/sw_services/xillibpm/src/server/xillibpm_psm_api.c
lib/sw_services/xillibpm/src/server/xillibpm_psm_api.h
lib/sw_services/xillibpm/src/server/xpm_ipi.c
lib/sw_services/xillibpm/src/server/xpm_ipi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file pipeline_program.c This file
contains the video pipe line configuration, Sensor configuration and its
programming as per the resolution selected by user. Please see
pipeline_program.h for more details. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 pg 12/07/17 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/pipeline_program.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file pipeline_program.h This
header file contains the definitions for structures for video pipeline and
extern declarations. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 pg 12/07/17 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/pipeline_program.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file sensor_cfgs.c This file
contains the IMX274 CSI2 Camera sensor configurations for IMX274 -
1280x720@60fps (quad lane) - 1920x1080@30fps (quad lane) - 1920x1080@60fps (quad
lane) - 3840x2160@30fps (quad lane) - 3840x2160@60fps (quad lane) The structure
names are sensor_<lane_count>L_<resolution>_<fps>fps_regs[] <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 pg 12/07/17 Initial
release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/sensor_cfgs.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file sensor_cfgs.h This header
file contains the definitions for structures for video pipeline and extern
declarations. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 pg 12/07/17 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/sensor_cfgs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si5324drv.c This file
contains low-level driver functions for controlling the SiliconLabs Si5324 clock
generator as mounted on the KC705 demo board. The user should refer to the
hardware device specification for more details of the device operation. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- ---------- 1.00 hf
2014/10/10 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/si5324drv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si5324drv.h This file
contains definitions for low-level driver functions for controlling the
SiliconLabs Si5324 clock generator as mounted on the KC705 demo board. The user
should refer to the hardware device specification for more details of the device
operation. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- ----------
1.00 hf 2014/10/10 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/si5324drv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmipi_example.c This file
demonstrates the Xilinx MIPI CSI2 Rx Subsystem and MIPI DSI2 Tx Subsystem. The
video pipeline is created by connecting an IMX274 Camera sensor to the MIPI CSI2
Rx Subsystem. The sensor is programmed to generate RAW10 type de bayered data as
per the pipeline configuration. The raw pixels are fed to Xilinx Demosaic, Gamma
lut and v_proc_ss IPs to convert pixel to RGB format. The RGB pixels are then
sent across to a data Video Test Pattern Generator. In a pass through mode, the
camera data is passed to an AXI Stream broadcaster. This sends across video
stream to along HDMI Tx Subsystem and a Video Processing Subsystem configured as
Scalar. The output of the scalar is connected to the DSI2 Tx Subsystem. The DSI2
output is connected to AUO Asus Display panel with 1920x1200 fixed resolution
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 pg
12/07/17 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/xmipi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmipi_menu.c This file
contains the Xilinx Menu implementation as used in the MIPI example design.
Please see xmipi_menu.h for more details. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 pg 12/07/17 Initial release. </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/xmipi_menu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmipi_menu.h This is the main
header file for the Xilinx Menu implementation as used in the MIPI example
design. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 pg 12/07/17 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/examples/xmipi_ref_design/xmipi_menu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss.c @addtogroup csiss_v1_1
@{ This is main code of Xilinx MIPI CSI Rx Subsystem device driver. Please see
xcsiss.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes --- --- -------- 1.0 vsa 07/21/15 Initial release 1.1 sss 08/17/16
Added 64 bit support sss 08/29/16 Added check for Dphy register interface </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/src/xcsiss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss.h @addtogroup csiss_v1_1
@{ @details This is main header file of the Xilinx MIPI CSI Rx Subsystem driver.
<b>MIPI CSI Rx Subsystem Overview</b> MIPI CSI Subsystem is collection of IP
cores to control, receive and translate data received from a MIPI CSI
Transmitter. The MIPI CSI2 Rx Subsystem is a plug-in solution for interfacing
with MIPI CSI based image sensors and rest of the video pipeline. It hides all
the complexities of programming the underlying cores from end user. <b>Core
Features</b> MIPI CSI Rx Subsystem supports following features - Support for 1
to 4 PPI Lanes. - Line rates ranging from 80 to 1500 Mbps. - Different data type
support(RAW,RGB,YUV). - AXI IIC support for CCI Interface. - Using existing AXI
IIC for CCI interface support for better understanding & compatibility with
other IIC’s (if any) used in the system - Filtering of packets based on
Virtual channel ID. - Single,Dual,Quad pixel support at output interface
compliant to UG934 format. The GUI in IPI allows for the following
configurations - Lanes ( 1 to 4 ) - Pixel Format (All RAW and RGB, only YUV422
8bit) - Virtual Channel (to filter or allow all from interlaced streams) -
Number of Pixels per clock (1, 2, 4) - DPHY with/without Register interface -
Line Rate - Buffer Depth - Embedded Non Image data (if needed) - Add IIC to
subsystem (if required) The IIC can be added if the system doesn't contain an
IIC or if a dedicated IIC is to be used for MIPI CSI Rx Subsystem. In order to
reduce resource usage, the DPHY can be configured to be without register
interface with fixed functions. Static configuration parameters are stored in
xcsiss_g.c file that gets generated when compiling the board support package
(BSP). A table is defined where each entry contains configuration information
for the instances of the subsystem in the design. This information includes the
elected configuration, sub-cores used and their device ID, base addresses of
memory mapped devices and address range available for subsystem frame/field
buffers. The subsystem driver itself always includes the full software stack
irrespective of the configuration selected. Generic API's are provided to
interact with the subsystem and/or with the included sub -cores. At run-time the
subsystem will query the static configuration and configures itself for
supported use cases The subsystem driver provides an abstraction on top of the
CSI and DPHY drivers. The IIC instance (if present) is shared with application
and can be controlled using the AXI IIC driver. <b>Software Initialization &
Configuration</b> The application needs to do following steps in order for
preparing the MIPI CSI2 Rx Subsystem core to be ready. - Call
XCsiSs_LookupConfig using a device ID to find the core configuration. - Call
XCsiSs_CfgInitialize to initialize the device and the driver instance associated
with it. <b>Interrupts</b> The XCsiSs_SetCallBack() is used to register the call
back functions for MIPI CSI2 Rx Subsystem driver with the corresponding handles
<b> Virtual Memory </b> This driver supports Virtual Memory. The RTOS is
responsible for calculating the correct device base address in Virtual Memory
space. <b> Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by
defining, at compile time, the NDEBUG identifier. By default, asserts are turned
on and it is recommended that application developers leave asserts on during
development. <b>Building the driver</b> The MIPI CSI2 Rx Subsystem driver is
composed of source files and depends on the CSI and DPHY drivers. The IIC driver
is pulled in if the the IIC instance is enabled. The DPHY driver is pulled in
only if the register interface has been enabled for it.Otherwise the CSI driver
and subsystem files are built. <pre> MODIFICATION HISTORY: Ver Who Date Changes
--- --- -------- 1.0 vsa 07/25/15 Initial release 1.1 sss 08/17/16 Added 64 bit
support sss 08/29/16 Renamed SubCore to CsiRxSsSubCore ms 01/23/17 Modified
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/src/xcsiss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss_hw.h @addtogroup
csiss_v1_1 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the Xilinx MIPI CSI Rx
Subsystem core. For more information about the operation of this core see the
hardware specification and documentation in the higher level driver xcsiss.h
file. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0 vsa
07/25/15 Initial release 1.1 sss 08/17/16 Added 64 bit support 1.2 vsa 03/12/17
Add Word Count corruption interrupt support </pre>

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/src/xcsiss_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss_intr.c @addtogroup
csiss_v1_1 @{ This is the interrupt handling part of the Xilinx MIPI CSI Rx
Subsystem device driver. The interrupt registration and handler are defined
here. The callbacks are registered for events which are interrupts clubbed
together on the basis of the CSI specification. Refer to CSI driver for the
event groups. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------
1.0 vsa 07/27/15 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/src/xcsiss_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss_selftest.c @addtogroup
csiss_v1_1 @{ This file contains self test function for the MIPI CSI Rx
Subsystem <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- -------- 1.0
vsa 07/21/15 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/src/xcsiss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcsiss_sinit.c @addtogroup
csiss_v1_1 @{ This file contains the implementation of the MIPI CSI Rx Subsystem
driver's static initialization functionality. <pre> MODIFICATION HISTORY: Ver
Who Date Changes --- --- -------- 1.0 vsa 07/21/15 Initial release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/mipicsiss/src/xcsiss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Ver Who Date Changes -------- ------
-------- 4.0 adk 10/12/13 Removed support for xps_mutex @BEGIN_CHANGELOG EDK_MS3
07/25/10 sdm removed support for opb_mutex @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/mutex/data/mutex.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 3.01a sdm 05/06/10 Updated to support AXI
common::version of the core 3.01a sdm 05/06/11 Updated to handle mutex connected
through axi2axiconnector 3.02a bss 01/31/13 Updated script to fix CR 679127 4.0
bss 12/10/13 Updated as per the New Tcl API's 4.1 sk 11/09/15 Removed delete
filename statement CR 784758. 4.3 ms 04/18/17 Modified tcl file to add suffix U
for all macros definitions of mutex in xparameters.h uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/mutex/data/mutex.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_K_SP2 - Initial Revision @END_CHANGELOG Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/mutex/data/mutex_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmutex_tapp_example.c This file
contains a design example for using the Mutex hardware and driver XMutex The
example assumes there are two processors availabile in the system that are
expected to inter-communicate. This example attempts to lock the Mutex from the
processor identified as 0 (XPAR_CPU_ID0) to prevent the other processor from
getting the lock. Since the application is running on two seperate processors,
the initiator declares success when the Mutex locks the other processor declares
success when the Mutex is locked from its perspective. There is no feedback to
the initiator so a terminal is required for each processor to verify that the
test passed for both sides. This example has been tested on ML505 Hardware
Evaluation board. @note These code fragments will illustrate how the XMutex
driver can be used to: - Initialize the Mutex core - Lock, Unlock and query the
status of the hardware <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a va First release 1.00a ecm 06/04/07 Cleanup, new coding
standard, check into XCS 1.00a ecm 08/28/08 Converted to testapp example 3.01a
sdm 05/04/10 Removed printfs from the MutexExample 4.2 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mutex/examples/xmutex_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmutex.c @addtogroup mutex_v4_3
@{ Contains required functions for the XMutex driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a va First release 1.00b
ecm 06/01/07 Cleanup, new coding standard, check into XCS 2.00a hm 04/14/09
Fixed CR 466322, removed extra definitions Also fixed canonical definitions
treating an interface as an device instance. 3.00a hbm 10/15/09 Migrated to HAL
phase 1 to use xil_io, xil_types, and xil_assert. 4.00a bss 03/05/14 Modified
XMutex_CfgInitialize to fix CR 770096 4.1 sk 11/10/15 Used UINTPTR instead of
u32 for Baseaddress CR 867425. Changed the prototype of XMutex_CfgInitialize
API. 4.2 mi 09/22/16 Fixed compilation warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mutex/src/xmutex.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmutex.h @addtogroup mutex_v4_3
@{ @details The Xilinx Mutex driver. This driver supports the Xilinx Mutex Core.
More detailed description of the driver operation can be found in the xmutex.c
file. <b>Features</b> The Xilinx Mutex supports the following features: -
Provide for synchronization between multiple processors in the system. - Write
to lock scheme with CPU ID encoded. - Multiple Mutex locks within a single
instance of the device. - An optional user field within each Mutex that can be
read or written to by software. This driver is intended to be RTOS and processor
independent. Any needs for dynamic memory management, threads or thread mutual
exclusion, virtual memory, or cache control must be satisfied by the layer above
this driver. The effective address provided to the XMutex_CfgInitialize()
function can be either the real, physical address or the remapped virtual
address. The remapping of this address occurs above this driver, no remapping
occurs within the driver itself. <b>Initialization & Configuration</b> The
XMutex_Config structure is used by the driver to configure itself. This
configuration structure is typically created by the tool-chain based on HW build
properties. To support multiple runtime loading and initialization strategies
employed by various operating systems, the driver instance can be initialized in
the following way: - XMutex_LookupConfig (DeviceId) - Use the device identifier
to find the static configuration structure defined in XMutex_g.c. This is setup
by the tools. For some operating systems the config structure will be
initialized by the software and this call is not needed. This function returns
the CfgPtr argument used by the CfgInitialize function described below. -
XMutex_CfgInitialize (InstancePtr, ConfigPtr, EffectiveAddress) - Uses a
configuration structure provided by the caller. If running in a system with
address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. The EffectiveAddress
argument is required regardless of operating system environment, i.e. in
standalone, ConfigPtr->BaseAddress is recommended and not the xparameters
definition.. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a va First release 1.00a ecm 06/01/07 Cleanup, new coding standard,
check into XCS 1.00b ecm 06/01/07 fixed tcl error for number of mutex's,
CR502416 2.00a hm 04/14/09 Fixed CR 466322, removed extra definitions Also fixed
canonical definitions treating an interface as an device instance. 3.00a hbm
10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types, and xil_assert. 3.01a
sdm 05/06/10 New driver to support AXI version of the core and cleaned up for
coding guidelines. 3.02a bss 01/31/13 Updated driver tcl to fix CR 679127 4.0
adk 19/12/13 Updated as per the New Tcl API's 4.00a bss 03/05/14 Modified
XMutex_CfgInitialize to fix CR 770096 4.1 sk 11/10/15 Used UINTPTR instead of
u32 for Baseaddress CR 867425. Changed the prototype of XMutex_CfgInitialize
API. 4.2 mi 09/22/16 Fixed compilation warnings. ms 01/23/17 Modified xil_printf
statement in main function for all examples to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 03/17/17 Added readme.txt file in examples folder for doxygen generation. 4.3
ms 04/18/17 Modified tcl file to add suffix U for all macros definitions of
mutex in xparameters.h ms 08/07/17 Fixed compilation warnings in xmutex_sinit.c
</pre>

FILES:
XilinxProcessorIPLib/drivers/mutex/src/xmutex.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmutex_g.c @addtogroup
mutex_v4_3 @{ This file contains a configuration table that specifies the
configuration of Mutex devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a ecm 06/01/07 Cleanup, new coding
standard, check into XCS </pre> @note None. Include Files /

FILES:
XilinxProcessorIPLib/drivers/mutex/src/xmutex_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmutex_hw.h @addtogroup
mutex_v4_3 @{ This header file contains identifiers/definitions and macros that
can be used to access the device. The user should refer to the hardware device
specification for more details of the device operation. The driver functions are
defined in xmutex.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a va First release 1.00a ecm 06/01/07 Cleanup, new coding standard,
check into XCS 3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io,
xil_types, and xil_assert. </pre>

FILES:
XilinxProcessorIPLib/drivers/mutex/src/xmutex_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmutex_selftest.c @addtogroup
mutex_v4_3 @{ Contains XMutex driver selftest code. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a va First release 1.00a ecm
06/01/07 Cleanup, new coding standard, check into XCS 3.00a hbm 10/15/09
Migrated to HAL phase 1 to use xil_io, xil_types, and xil_assert. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/mutex/src/xmutex_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmutex_sinit.c @addtogroup
mutex_v4_3 @{ Implements static initialization See xmutex.h for more information
about the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 4.3 ms
08/07/17 Fixed compilation warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/mutex/src/xmutex_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/22/11 Created 2.0 adk 12/10/13 Updated
as per the New Tcl API's 2.3 ms 04/18/17 Modified tcl file to add suffix U for
all macros definitions of nandps in xparameters.h uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/nandps/data/nandps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_cache_example.c This
file contains a design example using the NAND driver (XNandPs). This example
tests NAND page cache read and write commands. The page cache commands are not
supported by OnDie ECC flash since ECC is enabled by default. Tested Spansion
S34ML04G100TFI00 flash with this example. This example tests the block erase,
block read and block write features. The flash blocks are erased and written.
The data is read back and compared with the data written for correctness. The
bad blocks are not erased/programmed. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- ---------- 1.00 nm 04/25/2013 First release. ms
04/10/17 Modified Comment lines to follow doxygen rules </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/examples/xnandps_cache_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_example.c This file
contains a design example using the NAND driver (XNandPs). This example tests
the block erase, block read and block write features. The flash blocks are
erased and written. The data is read back and compared with the data written for
correctness. The bad blocks are not erased/programmed. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- ---------- 1.00 nm
12/10/2010 First release. 1.01a nm 28/02/2012 Modified the test offsets. ms
04/10/17 Modified Comment lines to follow doxygen rules </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/examples/xnandps_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_skip_example.c This
file contains a design example using the NAND driver (XNandPs). This example
tests the skip block method of erase/read/write operations. The skip block
method is useful while reading/writing images on to the flash. The flash is
erased and programming by considering the bad blocks. The data is read back and
compared with the data written for correctness. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- ---------- 1.00 nm 12/10/2010 First
release 1.01a nm 28/02/2012 Modified the test offsets. ms 04/10/17 Modified
Comment lines to follow doxygen rules </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/examples/xnandps_skip_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps.c @addtogroup
nandps_v2_4 @{ This file contains the implementation of the interface functions
for XNandPs driver. Refer to the header file xnandps.h for more detailed
information. This module supports for NAND flash memory devices that conform to
the "Open NAND Flash Interface" (ONFI) Specification. This modules implements
basic flash operations like read, write and erase. @note None <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- ---------- 1.00a nm 12/10/2010 First
release 1.01a nm 28/02/2012 Fixed 16-bit issue with ONFI commands like read,
write and read status command. The config structure width is updated after ONFI
query with the parameter page width. 1.02a nm 20/09/2012 Removed setting of
set_cycles and set_opmode register values as it is now done in FSBL using the
PCW generated files. CR678949. 1.03a nm 10/22/2012 Fixed CR 673348. 1.04a nm
04/15/2013 Fixed CR 704401. Removed warnings when compiled with -Wall and
-Wextra option in bsp. 04/25/2013 Implemented PR 699544. Added page cache read
and program support. Added API's XNandPs_ReadCache and XNandPs_WriteCache for
page cache support. Added ECC handling functions XNandPs_EccSetCfg,
XNandPs_EccSetMemCmd1...etc, to support better usage of ECC block for page cache
commands. Modified Read/Write API's so that there is common code for normal
read/write and page cache commands. Disabling/Re-enabling ECC block in
read/write API's of spare bytes since we don't calculate ECC for spare bytes.
2.01 kpc 07/24/2014 Fixed CR808770. Update command register twice only if flash
device requires > four address cycles. 2.2 sb 01/31/2015 Use the address cycles
defined in onfi parameter page than hardcoding this value to 5 for read and
write operations. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps.h @addtogroup
nandps_v2_4 @{ @details This file implements a driver for the NAND flash
controller. <b>Driver Initialization</b> The function call
XNandPs_CfgInitialize() should be called by the application before any other
function in the driver. The initialization function takes device specific data
(like device id, instance id, and base address) and initializes the XNandPs
instance with the device specific data. <b>Device Geometry</b> NAND flash device
is memory device and it is segmented into areas called Logical Unit(s) (LUN) and
further in to blocks and pages. A NAND flash device can have multiple LUN. LUN
is sequential raw of multiple blocks of the same size. A block is the smallest
erasable unit of data within the Flash array of a LUN. The size of each block is
based on a power of 2. There is no restriction on the number of blocks within
the LUN. A block contains a number of pages. A page is the smallest addressable
unit for read and program operations. The arrangement of LUN, blocks, and pages
is referred to by this module as the part's geometry. The cells within the part
can be programmed from a logic 1 to a logic 0 and not the other way around. To
change a cell back to a logic 1, the entire block containing that cell must be
erased. When a block is erased all bytes contain the value 0xFF. The number of
times a block can be erased is finite. Eventually the block will wear out and
will no longer be capable of erasure. As of this writing, the typical flash
block can be erased 100,000 or more times. The jobs done by this driver
typically are: - 8/16 bit operational mode - Read, Write, and Erase operation -
Read, Write cache operation - Read, Write Spare area operation - HW Error Check
and Correction (ECC) <b>Write Operation</b> The write call can be used to write
a minimum of one byte and a maximum entire flash. If the address offset
specified to write is out of flash or if the number of bytes specified from the
offset exceed flash boundaries an error is reported back to the user. The write
is blocking in nature in that the control is returned back to user only after
the write operation is completed successfully or an error is reported. <b>Read
Operation</b> The read call can be used to read a minimum of one byte and
maximum of entire flash. If the address offset specified to read is out of flash
or if the number of bytes specified from the offset exceed flash boundaries an
error is reported back to the user. The read is blocking in nature in that the
control is returned back to user only after the read operation is completed
successfully or an error is reported. <b>Erase Operation</b> The erase
operations are provided to erase a Block in the Flash memory. The erase call is
blocking in nature in that the control is returned back to user only after the
erase operation is completed successfully or an error is reported. <b>Page Cache
Write Operation</b> The page cache write call is same as write call except that
it uses cache commands to write. This enhances the performance. This operation
can't be performed on OnDie ECC with internal ECC enabled. There is no way to
disable internal ECC for OnDie ECC flash parts in current driver. This operation
is tested with Spansion S34ML04G100TFI00 flash. We have to use this operation
only on the flash parts which supports program page cache command. <b>Page Cache
Read Operation</b> The page cache read call is same as read call except that it
uses cache commands to read. This enhances the performance. The read cache
random command is used since the HW ECC block doesn't support commands without
address for starting ECC. This operation can't be performed on OnDie ECC with
internal ECC enabled. There is no way to disable internal ECC for OnDie ECC
flash parts in current driver. This operation is tested with Spansion
S34ML04G100TFI00 flash. We have to use this operation only on the flash parts
which supports read page cache command (random). <b>Write Spare Bytes
Operation</b> This call writes to user specified buffer into spare bytes of a
page. <b>Read Spare Bytes Operation</b> This call reads spare bytes of a page
into user specified buffer. @note This driver is intended to be RTOS and
processor independent. It works with physical addresses only. Any needs for
dynamic memory management, threads, mutual exclusion, virtual memory, cache
control, or HW write protection management must be satisfied by the layer above
this driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
---------- 1.00a nm 12/10/2010 First release nm 29/09/2011 Added support for On-
Die ECC NAND and Clean NAND flash parts. Added user spare buffer pointer to
read/write API's. Added new API's for reading and writing spare buffer area.
Changes nand_cycles with ONFI timing mode 0. Modified ONFI parameter page
reading to read 3 mandatory pages. 1.01a nm 28/02/2012 Added tcl file to
generate xparameters.h. Added support for 8Gb On-Die ECC NAND flash parts (CR
648463). Fixed 16-bit issue with ONFI commands like read, write and read status
command. 1.02a nm 20/09/2012 Removed setting of set_cycles and set_opmode
register values as it is now done in FSBL using the PCW generated files.
CR678949. 1.03a nm 10/22/2012 Fixed CR 683787,673348. 1.04a nm 04/15/2013 Fixed
CR 704401. Removed warnings when compiled with -Wall and -Wextra option in bsp.
04/25/2013 Implemented PR 699544. Added page cache read and program support.
Added API's XNandPs_ReadCache and XNandPs_WriteCache for page cache support.
Added XNandPs_Features structure to XNandPs instance which contains features
handled by driver. Added function prototypes for Page cache read/write and spare
byte read/write API's. 2.0 adk 12/10/13 Updated as per the New Tcl API's 2.1 kpc
07/24/13 Fixed CR808770. Update command register twice only if flash device
requires > four address cycles. 2.2 sb 01/31/2015 Use the address cycles defined
in onfi parameter page than hardcoding this value to 5 for read and write
operations. ms 03/17/17 Added readme.txt file in examples folder for doxygen
generation. ms 04/10/17 Modified Comment lines in examples to follow doxygen
rules. 2.3 ms 04/18/17 Modified tcl file to add suffix U for all macros
definitions of nandps in xparameters.h 2.4 nsk 06/20/18 Fixed BBT offset
overflow in XNandPs_WriteBbt() and XNandPs_ReadBbt(). </pre>

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_bbm.c @addtogroup
nandps_v2_4 @{ This file implements the Bad Block Management (BBM)
functionality. See xnandps_bbm.h for more details. @note None <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- ---------- 1.00a nm 12/10/2010 First
release 1.03a nm 10/22/2012 Fixed CR 683787. 2.4 nsk 06/20/2018 Fixed BBT offset
overflow in XNandPs_WriteBbt() and XNandPs_ReadBbt(), overflow causes incorrect
BBT writes. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps_bbm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_bbm.h @addtogroup
nandps_v2_4 @{ This file implements the Bad Block Management(BBM) functionality.
This is similar to the Bad Block Management which is a part of the MTD subsystem
in Linux. The factory marked bad blocks are scanned initially and a Bad Block
Table(BBT) is created in the memory. This table is also written to the flash so
that upon reboot, the BBT is read back from the flash and loaded into the memory
instead of scanning every time. The Bad Block Table(BBT) is written into one of
the the last four blocks in the flash memory. The last four blocks are marked as
Reserved so that user can't erase/program those blocks. There are two bad block
tables, a primary table and a mirror table. The tables are versioned and
incrementing version number is used to detect and recover from interrupted
updates. Each table is stored in a separate block, beginning in the first page
of that block. Only two blocks would be necessary in the absence of bad blocks
within the last four; the range of four provides a little slack in case one or
two of those blocks is bad. These blocks are marked as reserved and cannot be
programmed by the user. A NAND Flash device with 3 or more factory bad blocks in
the last 4 cannot be used. The bad block table signature is written into the
spare data area of the pages containing bad block table so that upon rebooting
the bad block table signature is searched and the bad block table is loaded into
RAM. The signature is "Bbt0" for primary Bad Block Table and "1tbB" for Mirror
Bad Block Table. The version offset follows the signature offset in the spare
data area. The version number increments on every update to the bad block table
and the version wraps at 0xff. Each block in the Bad Block Table(BBT) is
represented by 2 bits. The two bits are encoded as follows in RAM BBT. 0'b00 ->
Good Block 0'b01 -> Block is bad due to wear 0'b10 -> Reserved block 0'b11 ->
Factory marked bad block While writing to the flash the two bits are encoded as
follows. 0'b00 -> Factory marked bad block 0'b01 -> Reserved block 0'b10 ->
Block is bad due to wear 0'b11 -> Good Block The user can check for the validity
of the block using the API XNandPs_IsBlockBad and take the action based on the
return value. Also user can update the bad block table using
XNandPs_MarkBlockBad API. @note None <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- ---------- 1.00a nm 12/10/2010 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps_bbm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_g.c @addtogroup
nandps_v2_4 @{ This file contains a configuration table that specifies the
configuration of NAND flash devices in the system. See xnandps.h for more
information about this driver. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- ---------- 1.00a nm 12/10/2010 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_hw.h @addtogroup
nandps_v2_4 @{ This file contains identifiers and low-level macros/functions for
the NAND Flash controller driver. See xnandps.h for more information. @note None
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- ---------- 1.00a nm
12/10/2010 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_onfi.c @addtogroup
nandps_v2_4 @{ This module implements the ONFI specific commands. See
xnandps_onfi.h for more information. @note None <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- ---------- 1.00a nm 12/10/2010 First release 1.01a
nm 28/02/2012 Added support for 8Gb On-Die ECC NAND flash parts (CR 648463).
Fixed 16-bit issue with ONFI commands like read, write and read status command.
1.03a nm 10/22/2012 Fixed CR 673348. 1.04a nm 04/25/2013 Implemented PR 699544.
Added page cache read and program commands to ONFI command list. Reading the
cache features during read param page. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps_onfi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_onfi.h @addtogroup
nandps_v2_4 @{ This file implements ONFI specific commands which are used to get
the parameter page information. The following commands are supported currently.
- Reset - Read ID - READ Parameter Page - Read Status - Change Read Column - Get
Features - Set Features @note None <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- ---------- 1.00a nm 12/10/2010 First release 1.04a nm
04/25/2013 Implemented PR 699544. Added page cache read and program commands to
ONFI command list. </pre>

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps_onfi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandps_sinit.c @addtogroup
nandps_v2_4 @{ This file contains the implementation of the XNand driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- ---------- 1.00a nm 12/10/2010 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandps/src/xnandps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a nm 05/06/14 Created 1.2 ms 02/12/17 Fix for
compilation warning. 1.3 nsk 14/08/17 Added CCI support uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/nandpsu/data/nandpsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_example.c This file
contains a design example using the NAND driver (XNandPsu). This example tests
the erase, read and write features of the controller. The flash is erased and
written. The data is read back and compared with the data written for
correctness. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- ---------- 1.0 nm 05/06/2014 First release. ms 04/10/17 Modified Comment
lines to follow doxygen rules. 1.4 nsk 10/04/2018 Added support for ICCARM
Compiler. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandpsu/examples/xnandpsu_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu.c @addtogroup
nandpsu_v1_3 @{ This file contains the implementation of the interface functions
for XNandPsu driver. Refer to the header file xnandpsu.h for more detailed
information. This module supports for NAND flash memory devices that conform to
the "Open NAND Flash Interface" (ONFI) 3.0 Specification. This modules
implements basic flash operations like read, write and erase. @note Driver has
been renamed to nandpsu after change in naming convention. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- ---------- 1.0 nm 05/06/2014 First
release 2.0 sb 01/12/2015 Removed Null checks for Buffer passed as parameter to
Read API's - XNandPsu_Read() - XNandPsu_ReadPage Modified -
XNandPsu_SetFeature() - XNandPsu_GetFeature() and made them public. Removed
Failure Return for BCF Error check in XNandPsu_ReadPage() and added BCH_Error
counter in the instance pointer structure. Added XNandPsu_Prepare_Cmd API
Replaced - XNandPsu_IntrStsEnable - XNandPsu_IntrStsClear - XNandPsu_IntrClear -
XNandPsu_SetProgramReg with XNandPsu_WriteReg call Modified xnandpsu.c file
API's with above changes. Corrected the program command for Set Feature API.
Modified - XNandPsu_OnfiReadStatus - XNandPsu_GetFeature - XNandPsu_SetFeature
to add support for DDR mode. Changed Convention for SLC/MLC SLC HAMMING MLC BCH
SlcMlc IsBCH Removed extra DMA mode initialization from the
XNandPsu_CfgInitialize API. Modified - XNandPsu_SetEccAddrSize ECC address now
is calculated based upon the size of spare area Modified Block Erase API,
removed clearing of packet register before erase. Clearing Data Interface
Register before XNandPsu_OnfiReset call. Modified XNandPsu_ChangeTimingMode API
supporting SDR and NVDDR interface for timing modes 0 to 5. Modified Bbt
Signature and Version Offset value for Oob and No-Oob region. 1.0 kpc 17/6/2015
Added timer based timeout intsead of sw counter. 1.1 mi 09/16/16 Removed
compilation warnings with extra compiler flags. 1.1 nsk 11/07/16 Change memcpy
to Xil_MemCpy to handle word aligned data access. 1.2 nsk 01/19/17 Fix for the
failure of reading nand first redundant parameter page. CR966603 1.3 nsk
08/14/17 Added CCI support 1.4 nsk 04/10/18 Added ICCARM compiler support.
CR997552. 1.5 mus 11/05/18 Support 64 bit DMA addresses for Microblaze-X
platform. 1.5 mus 11/05/18 Updated XNandPsu_ChangeClockFreq to fix compilation
warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu.h @addtogroup
nandpsu_v1_3 @{ @details This file implements a driver to support Arasan NAND
controller present in Zynq Ultrascale Mp. <b>Driver Initialization</b> The
function call XNandPsu_CfgInitialize() should be called by the application
before any other function in the driver. The initialization function takes
device specific data (like device id, instance id, and base address) and
initializes the XNandPsu instance with the device specific data. <b>Device
Geometry</b> NAND flash device is memory device and it is segmented into areas
called Logical Unit(s) (LUN) and further in to blocks and pages. A NAND flash
device can have multiple LUN. LUN is sequential raw of multiple blocks of the
same size. A block is the smallest erasable unit of data within the Flash array
of a LUN. The size of each block is based on a power of 2. There is no
restriction on the number of blocks within the LUN. A block contains a number of
pages. A page is the smallest addressable unit for read and program operations.
The arrangement of LUN, blocks, and pages is referred to by this module as the
part's geometry. The cells within the part can be programmed from a logic 1 to a
logic 0 and not the other way around. To change a cell back to a logic 1, the
entire block containing that cell must be erased. When a block is erased all
bytes contain the value 0xFF. The number of times a block can be erased is
finite. Eventually the block will wear out and will no longer be capable of
erasure. As of this writing, the typical flash block can be erased 100,000 or
more times. The jobs done by this driver typically are: - 8-bit operational mode
- Read, Write, and Erase operation <b>Write Operation</b> The write call can be
used to write a minimum of one byte and a maximum entire flash. If the address
offset specified to write is out of flash or if the number of bytes specified
from the offset exceed flash boundaries an error is reported back to the user.
The write is blocking in nature in that the control is returned back to user
only after the write operation is completed successfully or an error is
reported. <b>Read Operation</b> The read call can be used to read a minimum of
one byte and maximum of entire flash. If the address offset specified to read is
out of flash or if the number of bytes specified from the offset exceed flash
boundaries an error is reported back to the user. The read is blocking in nature
in that the control is returned back to user only after the read operation is
completed successfully or an error is reported. <b>Erase Operation</b> The erase
operations are provided to erase a Block in the Flash memory. The erase call is
blocking in nature in that the control is returned back to user only after the
erase operation is completed successfully or an error is reported. @note Driver
has been renamed to nandpsu after change in naming convention. This driver is
intended to be RTOS and processor independent. It works with physical addresses
only. Any needs for dynamic memory management, threads, mutual exclusion,
virtual memory, cache control, or HW write protection management must be
satisfied by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- ---------- 1.0 nm 05/06/2014 First release 2.0 sb
01/12/2015 Removed Null checks for Buffer passed as parameter to Read API's -
XNandPsu_Read() - XNandPsu_ReadPage Modified - XNandPsu_SetFeature() -
XNandPsu_GetFeature() and made them public. Removed Failure Return for BCF Error
check in XNandPsu_ReadPage() and added BCH_Error counter in the instance pointer
structure. Added XNandPsu_Prepare_Cmd API Replaced - XNandPsu_IntrStsEnable -
XNandPsu_IntrStsClear - XNandPsu_IntrClear - XNandPsu_SetProgramReg with
XNandPsu_WriteReg call Modified xnandpsu.c file API's with above changes.
Corrected the program command for Set Feature API. Modified -
XNandPsu_OnfiReadStatus - XNandPsu_GetFeature - XNandPsu_SetFeature to add
support for DDR mode. Changed Convention for SLC/MLC SLC HAMMING MLC BCH SlcMlc
IsBCH Added support for writing BBT signature and version in page section by
enabling XNANDPSU_BBT_NO_OOB. Removed extra DMA mode initialization from the
XNandPsu_CfgInitialize API. Modified - XNandPsu_SetEccAddrSize ECC address now
is calculated based upon the size of spare area Modified Block Erase API,
removed clearing of packet register before erase. Clearing Data Interface
Register before XNandPsu_OnfiReset call. Modified XNandPsu_ChangeTimingMode API
supporting SDR and NVDDR interface for timing modes 0 to 5. Modified Bbt
Signature and Version Offset value for Oob and No-Oob region. 1.0 kpc 17/06/2015
Increased the timeout for complete event to avoid timeout errors for erase
operation on slower devices. 1.1 mi 09/16/16 Removed compilation warnings with
extra compiler flags. 1.1 nsk 11/07/16 Change memcpy to Xil_MemCpy, CR960462 1.2
nsk 01/19/17 Fix for the failure of reading nand first redundant parameter page.
CR966603 ms 02/12/17 Fix for the compilation warning in _g.c file. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. ms 04/10/17
Modified Comment lines in nandpsu_example.c to follow doxygen rules. 1.2 nsk
08/08/17 Added support to import example in SDK 1.4 nsk 04/10/18 Added ICCARM
compiler support. CR997552. 1.5 mus 11/08/18 Updated BBT signature array size in
XNandPsu_BbtDesc structure to fix the compilation warnings. </pre>

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_bbm.c @addtogroup
nandpsu_v1_3 @{ This file implements the Bad Block Management (BBM)
functionality. See xnandpsu_bbm.h for more details. @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- ---------- 1.0 nm
05/06/2014 First release 2.0 sb 01/12/2015 Added support for writing BBT
signature and version in page section by enabling XNANDPSU_BBT_NO_OOB. Modified
Bbt Signature and Version Offset value for Oob and No-Oob region. 1.1 nsk
11/07/16 Change memcpy to Xil_MemCpy to handle word aligned data access. 1.4 nsk
04/10/18 Added ICCARM compiler support. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu_bbm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_bbm.h @addtogroup
nandpsu_v1_3 @{ This file implements the Bad Block Management(BBM)
functionality. This is similar to the Bad Block Management which is a part of
the MTD subsystem in Linux. The factory marked bad blocks are scanned initially
and a Bad Block Table(BBT) is created in the memory. This table is also written
to the flash so that upon reboot, the BBT is read back from the flash and loaded
into the memory instead of scanning every time. The Bad Block Table(BBT) is
written into one of the the last four blocks in the flash memory. The last four
blocks are marked as Reserved so that user can't erase/program those blocks.
There are two bad block tables, a primary table and a mirror table. The tables
are versioned and incrementing version number is used to detect and recover from
interrupted updates. Each table is stored in a separate block, beginning in the
first page of that block. Only two blocks would be necessary in the absence of
bad blocks within the last four; the range of four provides a little slack in
case one or two of those blocks is bad. These blocks are marked as reserved and
cannot be programmed by the user. A NAND Flash device with 3 or more factory bad
blocks in the last 4 cannot be used. The bad block table signature is written
into the spare data area of the pages containing bad block table so that upon
rebooting the bad block table signature is searched and the bad block table is
loaded into RAM. The signature is "Bbt0" for primary Bad Block Table and "1tbB"
for Mirror Bad Block Table. The version offset follows the signature offset in
the spare data area. The version number increments on every update to the bad
block table and the version wraps at 0xff. Each block in the Bad Block
Table(BBT) is represented by 2 bits. The two bits are encoded as follows in RAM
BBT. 0'b00 -> Good Block 0'b01 -> Block is bad due to wear 0'b10 -> Reserved
block 0'b11 -> Factory marked bad block While writing to the flash the two bits
are encoded as follows. 0'b00 -> Factory marked bad block 0'b01 -> Reserved
block 0'b10 -> Block is bad due to wear 0'b11 -> Good Block The user can check
for the validity of the block using the API XNandPsu_IsBlockBad and take the
action based on the return value. Also user can update the bad block table using
XNandPsu_MarkBlockBad API. @note None <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- ---------- 1.0 nm 05/06/2014 First release 2.0 sb 01/12/2015
Added support for writing BBT signature and version in page section by enabling
XNANDPSU_BBT_NO_OOB. Modified Bbt Signature and Version Offset value for Oob and
No-Oob region. </pre>

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu_bbm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_g.c @addtogroup
nandpsu_v1_3 @{ This file contains a configuration table where each entry is a
configuration structure for an XNandPsu device in the system. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- ---------- 1.0 nm 05/06/2014 First
release 1.0 nm 06/02/2014 Changed the copyright to new copyright </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_hw.h @addtogroup
nandpsu_v1_3 @{ This file contains identifiers and low-level macros/functions
for the Arasan NAND flash controller driver. See xnandpsu.h for more
information. @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- ---------- 1.0 nm 05/06/2014 First Release 2.0 sb 11/04/2014 Changed
XNANDPSU_ECC_SLC_MLC_MASK to XNANDPSU_ECC_HAMMING_BCH_MASK. </pre>

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_onfi.c @addtogroup
nandpsu_v1_3 @{ This file contains the implementation of ONFI specific
functions. @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- ---------- 1.0 nm 05/06/2014 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu_onfi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_onfi.h @addtogroup
nandpsu_v1_3 @{ This file defines all the ONFI 3.1 specific commands and values.
@note None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
---------- 1.0 nm 05/06/2014 First release 1.4 nsk 04/10/2018 Added ICCARM
compiler support. </pre>

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu_onfi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xnandpsu_sinit.c @addtogroup
nandpsu_v1_3 @{ The implementation of the XNandPsu driver's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- ---------- 1.0 nm 05/06/2014 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/nandpsu/src/xnandpsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00a adk 02/18/14 Removed the implementation of
interrupt_handler array.

FILES:
XilinxProcessorIPLib/drivers/osd/data/osd.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file osd_selftest_example.c This
file contains an example using the OSD driver to do self test on the core. @note
None. MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 4.0
adk 02/18/14 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/osd/examples/osd_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xosd.c @addtogroup osd_v4_0 @{
This file is main code of Xilinx Video On-Screen-Display (OSD) core. Please see
xosd.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00a xd 08/18/08 First release. 1.02a xd 12/21/10
Removed endian conversion for text bank loading. 1.03a cm 09/07/11 Updated
XOsd_GetLayerAlpha(), XOsd_SetLayerAlpha(), XOsd_SetBackgroundColor() and
XOsd_GetBackgroundColor() to allow 10 and 12 bit alpha and background colors.
2.00a cjm 12/18/12 Converted from xio.h to xil_io.h, translating basic types, MB
cache functions, exceptions and assertions to xil_io format. 4.0 adk 02/18/14
Renamed S_AXIS_VIDEO_DATA_WIDTH -> SlaveAxisVideoDataWidth. Removed from
XOsd_CfgInitialize: VbiStartCallBack, VbiStartRef, VbiEndCallBack, VbiEndRef.
Added in XOsd_CfgInitialize: ProcStartCallBack, ProcStartRef. Renamed the
following function prototypes: XOSD_CfgInitialize -> XOsd_CfgInitialize,
XOSD_SetScreenSize -> XOsd_SetActiveSize, XOSD_GetScreenSize ->
XOsd_GetActiveSize, XOSD_SetBackgroundColor -> XOsd_SetBackgroundColor,
XOSD_GetBackgroundColor -> XOSD_GetBackgroundColor, XOSD_SetLayerDimension ->
XOsd_SetLayerDimension, XOSD_GetLayerDimension -> XOsd_GetLayerDimension,
XOSD_SetLayerAlpha -> XOsd_SetLayerAlpha, XOSD_GetLayerAlpha ->
XOsd_GetLayerAlpha, XOSD_SetLayerAlpha -> XOsd_SetLayerAlpha, XOSD_GetLayerAlpha
-> XOsd_GetLayerAlpha, XOSD_SetLayerPriority -> XOsd_SetLayerPriority,
XOSD_GetLayerPriority -> XOsd_GetLayerPriority, XOSD_EnableLayer ->
XOsd_EnableLayer, XOSD_DisableLayer -> XOsd_DisableLayer, XOSD_LoadColorLUTBank
- > XOsd_LoadColorLUTBank, XOSD_LoadCharacterSetBank ->
XOsd_LoadCharacterSetBank, XOSD_LoadTextBank - > XOsd_LoadTextBank,
XOSD_SetActiveBank -> XOsd_SetActiveBank, XOSD_CreateInstruction ->
XOsd_CreateInstruction, XOSD_LoadInstructionList -> XOsd_LoadInstructionList,
XOSD_LookupConfig -> XOsd_LookupConfig, XOSD_IntrHandler -> XOsd_IntrHandler,
XOSD_SetCallBack -> XOsd_SetCallBack. Changed the prototype of XOSD_GetVersion
and renamed it as XOsd_GetVersion Removed the following function implementation:
XOSD_SetBlankPolarity. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/osd/src/xosd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xosd.h @addtogroup osd_v4_0 @{
@details This is main header file of the Xilinx On-Screen-Display (OSD) core. An
OSD is an image superimposed on a screen picture, commonly used by modern
televisions, VCRs, and DVD players to display information such as volume,
channel, and time. Xilinx OSD core has the following main features: - Read Video
Data from one of three sources as - VFBC/Frame Buffer, - VideoBus and - Graphics
Controller. - Alpha Compositing and Alpha Blending of up to 8 layers. - Up to 8
priorities, one for each of the layers. - Real-Time Graphics Controller. - Write
Composited Video Data to either - VFBC/Frame Buffer, or - VideoBus. For a full
description of OSD features, please see the hardware spec. <b>Interrupt Service
</b> Three interrupt types are supported: - Processing Start Interrupt - Frame
Done Interrupt - Error Interrupt <b>Software Initialization </b> Please follow
the example provided with this driver for the steps to use this driver. <b>Cache
Coherency</b> <b>Alignment</b> <b>Limitations</b> <b>BUS Interface</b> <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a xd
08/18/08 First release 1.01a xd 07/30/10 Added device version support; Supported
Doxygen; Fixed CR 534952 1.02a xd 12/21/10 Removed endian conversion for text
bank loading 1.03a cm 09/07/11 Updated XOSD_GetLayerAlpha(),
XOSD_SetLayerAlpha(), XOSD_SetBackgroundColor() and XOSD_GetBackgroundColor() to
allow 10 and 12 bit alpha and background colors. 2.00a cjm 12/18/12 Converted
from xio.h to xil_io.h, translating basic types, MB cache functions, exceptions
and assertions to xil_io format. 3.0 adk 19/12/13 Updated as per the New Tcl
API's. 4.0 adk 02/18/14 Converted defined macros to enum types. Removed
interrupt types XOSD_HANDLER_VBISTART and XOSD_HANDLER_VBIEND. Added interrupt
type: XOSD_HANDLER_PROCSTART. Renamed the following function macros: XOSD_Enable
-> XOsd_Enable, XOSD_Disable -> XOsd_Disable, XOSD_RegUpdateEnable ->
XOsd_RegUpdateEnable, XOSD_RegUpdateDisable -> XOsd_RegUpdateDisable, XOSD_Reset
-> XOsd_Reset, XOSD_IntrEnable -> XOsd_IntrEnable, XOSD_IntrDisable ->
XOsd_IntrDisable, XOSD_IntrGetPending -> XOsd_IntrGetPending, XOSD_IntrClear ->
XOsd_IntrClear. Added the following function macros: XOsd_SyncReset,
XOsd_StatusGetPending, XOsd_FSyncReset. Removed the following function macros:
XOSD_IntrEnableGlobal, XOSD_IntrDisableGlobal. Renamed S_AXIS_VIDEO_DATA_WIDTH
-> SlaveAxisVideoDataWidth. Removed struct members from core structure:
VbiStartCallBack, VbiStartRef, VbiEndCallBack, VbiEndRef. Added struct members
in core structure: ProcStartCallBack, ProcStartRef. Added the following function
prototypes: XOsd_SelfTest. Removed the following function prototypes:
XOSD_SetBlankPolarity. Changes in xosd_sinit.c: Renamed the following functions:
XOSD_LookupConfig - > XOsd_LookupConfig Changes in xosd_selftest.c: Implemented
the following functions: XOsd_SelfTest. Changes in xosd_intr.c: Renamed the
following functions: XOSD_IntrHandler - > XOsd_IntrHandler. XOSD_SetCallBack ->
XOsd_SetCallBack. Removed the following handlers: XOSD_HANDLER_VBISTART,
XOSD_HANDLER_VBIEND. Added new handler XOSD_HANDLER_PROCSTART. Added Doxygen
support, adherence to Xilinx coding guidelines. Changes in xosd_hw.h: Suffixed
"_OFFSET" to all register offset macros. Added register offsets, bit masks for
the registers and added backward compatibility for macros. Removed following
macros: XOSD_GIER_GIE_MASK, XOSD_IXR_GAO_MASK XOSD_IXR_GIE_MASK,
XOSD_IXR_OOE_MASK, XOSD_IXR_IUE_MASK, XOSD_IXR_VBIE_MASK, XOSD_IXR_VBIS_MASK,
XOSD_IXR_FE_MASK, XOSD_IXR_FD_MASK, XOSD_IXR_ALLIERR_MASK. Changes from xosd.c:
Renamed S_AXIS_VIDEO_DATA_WIDTH -> SlaveAxisVideoDataWidth. Removed from
XOsd_CfgInitialize: VbiStartCallBack, VbiStartRef, VbiEndCallBack, VbiEndRef.
Added in XOsd_CfgInitialize: ProcStartCallBack, ProcStartRef. Renamed the
following function prototypes: XOSD_CfgInitialize -> XOsd_CfgInitialize,
XOSD_SetScreenSize -> XOsd_SetActiveSize, XOSD_GetScreenSize ->
XOsd_GetActiveSize, XOSD_SetBackgroundColor -> XOsd_SetBackgroundColor,
XOSD_GetBackgroundColor -> XOSD_GetBackgroundColor, XOSD_SetLayerDimension ->
XOsd_SetLayerDimension, XOSD_GetLayerDimension -> XOsd_GetLayerDimension,
XOSD_SetLayerAlpha -> XOsd_SetLayerAlpha, XOSD_GetLayerAlpha ->
XOsd_GetLayerAlpha, XOSD_SetLayerAlpha -> XOsd_SetLayerAlpha, XOSD_GetLayerAlpha
-> XOsd_GetLayerAlpha, XOSD_SetLayerPriority -> XOsd_SetLayerPriority,
XOSD_GetLayerPriority -> XOsd_GetLayerPriority, XOSD_EnableLayer ->
XOsd_EnableLayer, XOSD_DisableLayer -> XOsd_DisableLayer, XOSD_LoadColorLUTBank
- > XOsd_LoadColorLUTBank, XOSD_LoadCharacterSetBank ->
XOsd_LoadCharacterSetBank, XOSD_LoadTextBank - > XOsd_LoadTextBank,
XOSD_SetActiveBank -> XOsd_SetActiveBank, XOSD_CreateInstruction ->
XOsd_CreateInstruction, XOSD_LoadInstructionList -> XOsd_LoadInstructionList,
XOSD_LookupConfig -> XOsd_LookupConfig, XOSD_IntrHandler -> XOsd_IntrHandler,
XOSD_SetCallBack -> XOsd_SetCallBack. Changed the prototype of XOSD_GetVersion
and renamed it as XOsd_GetVersion Removed the following function implementation:
XOSD_SetBlankPolarity. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/osd/src/xosd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xosd_hw.h @addtogroup osd_v4_0
@{ This header file contains identifiers and register-level driver functions (or
macros) that can be used to access the Xilinx Video On-Screen-Display (OSD)
core. For more information about the operation of this core, see the hardware
specification and documentation in the higher level driver xosd.h source code
file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00a xd 08/01/08 First release. 2.00a cm 06/12/12 14.1/14.2 release with
address map updated to match video over AXI4-Stream Specification. 2.00a cjm
12/18/12 Converted from xio.h to xil_io.h, translating basic types, MB cache
functions, exceptions and assertions to xil_io format. 4.0 adk 02/18/14 Suffixed
"_OFFSET" to all register offset macros. Added register offsets, bit masks for
the registers and added backward compatibility for macros. Removed following
macros: XOSD_GIER_GIE_MASK, XOSD_IXR_GAO_MASK XOSD_IXR_GIE_MASK,
XOSD_IXR_OOE_MASK, XOSD_IXR_IUE_MASK, XOSD_IXR_VBIE_MASK, XOSD_IXR_VBIS_MASK,
XOSD_IXR_FE_MASK, XOSD_IXR_FD_MASK, XOSD_IXR_ALLIERR_MASK. </pre>

FILES:
XilinxProcessorIPLib/drivers/osd/src/xosd_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xosd_intr.c @addtogroup
osd_v4_0 @{ This code contains interrupt related functions of Xilinx Video On-
Screen-Display core. Please see xosd.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a xd
08/18/08 First release. 2.00a cjm 12/18/12 Converted from xio.h to xil_io.h,
translating basic types, MB cache functions, exceptions and assertions to xil_io
format. 4.0 adk 02/18/14 Renamed the following functions: XOSD_IntrHandler - >
XOsd_IntrHandler. XOSD_SetCallBack -> XOsd_SetCallBack. Removed the following
handlers: XOSD_HANDLER_VBISTART, XOSD_HANDLER_VBIEND. Added new handler
XOSD_HANDLER_PROCSTART. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/osd/src/xosd_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xosd_selftest.c @addtogroup
osd_v4_0 @{ This file contains the self-test function for the OSD core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 4.0 adk
02/18/14 First Release. Implemented the following functions: XOsd_SelfTest.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/osd/src/xosd_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xosd_sinit.c @addtogroup
osd_v4_0 @{ This file contains the static initialization method for Xilinx Video
On-Screen-Display (OSD) core. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00a xd 08/18/08 First release 2.00a cjm 12/18/12
Converted from xio.h to xil_io.h, translating basic types, MB cache functions,
exceptions and assertions to xil_io format. 4.0 adk 02/18/14 Renamed the
following functions: XOSD_LookupConfig - > XOsd_LookupConfig </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/osd/src/xosd_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 nsk 02/19/18 First release 1.1 mus 07/31/19 Add
CCI support at EL1 NS uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/ospipsv/data/ospipsv.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv_flash_intr_example.c
This file contains a design example using the OSPIPSV driver (xospipsv) The
example writes to flash in IO mode and reads it back in DMA mode. It runs in
interrupt mode. The hardware which this example runs on, must have an octal
serial Flash (Micron) for it to run. This example has been tested with the
Micron Octal Serial Flash (mt35xu01gbba). @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.0 sk 01/09/19 First release
1.0 akm 03/29/19 Fixed data alignment issues on IAR compiler 1.1 sk 07/23/19
Based on RX Tuning, updated the dummy cycles. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ospipsv/examples/xospipsv_flash_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv_flash_polled_example.c
This file contains a design example using the OSPIPSV driver (xospipsv) The
example writes to flash in IO mode and reads it back in DMA mode. It runs in
polled mode. The hardware which this example runs on, must have an octal serial
Flash (Micron) for it to run. This example has been tested with the Micron Octal
Serial Flash (mt35xu01gbba). @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- --- -------- 1.0 nsk 02/19/17 First release sk 01/09/19
Updated flash configuration table with supported commands. sk 02/04/19 Add
support for SDR+PHY and DDR+PHY modes. 1.0 akm 03/29/19 Fixed data alignment
issues on IAR compiler. 1.1 sk 07/23/19 Based on RX Tuning, updated the dummy
cycles. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ospipsv/examples/xospipsv_flash_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv.c @addtogroup
xospipsv_v1_1 @{ This file implements the functions required to use the OSPIPSV
hardware to perform a transfer. These are accessible to the user via XOspiPsv.h.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.0 nsk
02/19/18 First release sk 01/09/19 Added interrupt mode support. Remove STIG/DMA
mode selection by the user, driver will take care of operating in DMA/STIG based
on command. Added support for unaligned byte count read. sk 02/04/19 Added
support for SDR+PHY and DDR+PHY modes. sk 02/07/19 Added OSPI Idling sequence.
1.1 sk 07/22/19 Added RX Tuning algorithm for SDR and DDR modes. 1.1 mus
07/31/19 Added CCI support at EL1 NS </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ospipsv/src/xospipsv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv.h @addtogroup
ospipsv_v1_1 @{ @details This is the header file for the implementation of
OSPIPSV driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- -----------------------------------------------. 1.0 nsk 02/19/18 First
release sk 01/09/19 Added interrupt mode support. Remove STIG/DMA mode selection
by the user, driver will take care of operating in DMA/STIG based on command.
Added support for unaligned byte count read. sk 02/04/19 Added support for
SDR+PHY and DDR+PHY modes. sk 02/07/19 Added OSPI Idling sequence. 1.0 akm
03/29/19 Fixed data alignment issues on IAR compiler. 1.1 sk 07/22/19 Added RX
Tuning algorithm for SDR and DDR modes. </pre>

FILES:
XilinxProcessorIPLib/drivers/ospipsv/src/xospipsv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv_g.c @addtogroup
ospipsv_v1_1 @{ @details This file contains a configuration table that specifies
the configuration of OSPI devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- --------
-----------------------------------------------. 1.0 sk 01/09/19 First release
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ospipsv/src/xospipsv_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv_hw.h @addtogroup
ospipsv_v1_1 @{ This file contains low level access functions using the base
address directly without an instance. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- -----------------------------------------------. 1.0
nsk 02/19/18 First release sk 02/04/19 Added support for SDR+PHY and DDR+PHY
modes. </pre>

FILES:
XilinxProcessorIPLib/drivers/ospipsv/src/xospipsv_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv_options.c @addtogroup
ospipsv_v1_1 @{ This file implements functions to configure the OSPIPSV
component, specifically some optional settings, clock and flash related
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.0 nsk 02/19/18 First release sk 01/09/19 Updated XOspiPsv_SetOptions() API to
support DAC mode switching. Removed Legacy/STIG mode option in OptionsTable. sk
02/04/19 Added support for SDR+PHY and DDR+PHY modes. 1.1 sk 07/22/19 Added RX
Tuning algorithm for SDR and DDR modes. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ospipsv/src/xospipsv_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xospipsv_sinit.c @addtogroup
ospipsv_v1_1 @{ The implementation of the XOspiPsv component's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.0 hk 02/19/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ospipsv/src/xospipsv_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: 08/08/18 bs
First Release

FILES:
XilinxProcessorIPLib/drivers/pciepsu/data/pciepsu.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 0.1 bs 08/21/2018 First release uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/pciepsu/data/pciepsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_ep_enable_example.c
This file contains a design example for using PS PCIe IP and its driver. This is
an example to show the usage of driver APIs which configures PS PCIe EndPoint.
The example initializes the PS PCIe EndPoint and shows how to use the API's.
This code will illustrate how the XPciePsu and its standalone driver can be used
to: - Initialize a PS PCIe bridge core built as an end point - Retrieve root
complex configuration assigned to end point - Provides ingress translation setup
We tried to use as much of the driver's API calls as possible to show the reader
how each call could be used and that probably made the example not the shortest
way of doing the tasks shown as they could be done. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 tk 02/13 Initial version </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/pciepsu/examples/xpciepsu_ep_enable_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_rc_enumerate_example.c
This file contains a design example for using PS PCIe root complex and its
driver. This is an example to show the usage of driver APIs which configures PS
PCIe root complex. The example initializes the PS PCIe root complex and shows
how to enumerate the PCIe system. This code will illustrate how the XPciePsu and
its standalone driver can be used to: - Initialize a PS PCIe root complex -
Enumerate PCIe end points in the system - Assign BARs to endpoints - find
capablities on end point Please note that this example enumerates and
initializes PCIe end points only. We tried to use as much of the driver's API
calls as possible to show the reader how each call could be used and that
probably made the example not the shortest way of doing the tasks shown as they
could be done. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 BS 21/08 Initial version </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/pciepsu/examples/xpciepsu_rc_enumerate_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu.c Implements all of
functions for psu_pci IP driver except interrupts and initialization <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 bs 08/21/2018
First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu.h This file contains
the software API definition of the Xilinx PSU PCI IP (psu_pcie). This driver
provides "C" function interface to application/upper layer to access the
hardware. <b>Features</b> The driver provides its user with entry points - To
initialize and configure itself and the hardware - To access PCIe configuration
space locally <b>Driver Initialization & Configuration</b> The XPciePsu_Config
structure is used by the driver to configure itself. This configuration
structure is typically created by the tool-chain based on HW build properties.
To support multiple runtime loading and initialization strategies employed by
various operating systems, the driver instance can be initialized in the
following way: - XPciePsu_LookupConfig(DeviceId) - Use the device identifier to
find the static configuration structure defined in xpciepsu_g.c. This is setup
by the tools. - XPciePsu_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddress) -
Uses a configuration structure provided by the caller. If running in a system
with address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 bs 08/21/2018 First
release </pre>

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_caps.c Implements all
of supportive functions to expose PCIe capabilities. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 bs 08/21/2018 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu_caps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_common.h Definitions
of commonly used macros. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 bs 08/21/2018 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_ep.c Implements all of
functions for psu_pci IP EndPoint driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 tk 02/13/2019 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu_ep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_ep.h This file
contains the software API definition of the Xilinx PSU PCI IP (psu_pcie). This
driver provides "C" function interface to application/upper layer to access the
hardware. <b>Features</b> The driver provides its user with entry points - To
initialize and configure itself and the hardware - To access PCIe configuration
space locally <b>Driver Initialization & Configuration</b> The XPciePsu_Config
structure is used by the driver to configure itself. This configuration
structure is typically created by the tool-chain based on HW build properties.
To support multiple runtime loading and initialization strategies employed by
various operating systems, the driver instance can be initialized in the
following way: - XPciePsu_LookupConfig(DeviceId) - Use the device identifier to
find the static configuration structure defined in xpciepsu_g.c. This is setup
by the tools. - XPciePsu_EP_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddress)
Uses a configuration structure provided by the caller. If running in a system
with address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 tk 02/13/2019 First
release </pre>

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu_ep.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_hw.h This header file
contains identifiers and basic driver functions for the XPciePsu device driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 bs
08/21/2018 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpciepsu_sinit.c This file
contains PSU PCIe driver's static initialization. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 bs 08/21/2018 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/pciepsu/src/xpciepsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 sd 01/20/19 Initial release uses
"xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/pmonpsv/data/pmonpsv.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmonpsv_selftest.c @addtogroup
xpmonpsv_v1_0 @{ This file contains a diagnostic self test function for the
XpsvPmon driver. The self test function does a simple read/write test of the
Alarm Threshold Register. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.0 sd 01/20/19 First release </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/pmonpsv/examples/xpmonpsv_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmonpsv.c @addtogroup
pmonpsv_v1_0 @{ This file contains the driver API functions that can be used to
access the Performance Monitor device. Refer to the xpmonpsv.h header file for
more information about this driver. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.0 sd 01/20/19 First release sd 03/05/19
Fix the counter check </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/pmonpsv/src/xpmonpsv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmonpsv.h @addtogroup
pmonpsv_v1_0 @{ @details The XpsvPmon driver supports the Xilinx Performance
Monitor device. For a full description of Performance Monitor features, please
see the hardware spec. This driver supports the following features: Computes
performance metrics for Agents connected to slots - Read request and response
counters - Lock and unlock the performance monitor. - Setting metrics like the
statperiod. - Readback of the metrics. <b> Initialization and Configuration </b>
The device driver enables higher layer software (e.g., an application) to
communicate to the Performance Monitor device. XpsvPmon_CfgInitialize() API is
used to initialize the AXI Performance Monitor device. The user needs to first
call the XpsvPmon_LookupConfig() API which returns the Configuration structure
pointer which is passed as a parameter to the XAxiPmon_CfgInitialize() API.
<b>Interrupts</b> The AXI Performance Monitor does not support Interrupts <b>
How to read the counters </b> XpsvPmon_GetReadCounter returns the contents of
the Read response and request counters. <b> Threads </b> This driver is not
thread safe. Any needs for threads or thread mutual exclusion must be satisfied
by the layer above this driver. TODO: Add the filter support <br><br> <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 sd 01/20/19
First release </pre>

FILES:
XilinxProcessorIPLib/drivers/pmonpsv/src/xpmonpsv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmonpsv_g.c @addtogroup
pmonpsv_v1_0 @{ This file contains a configuration table that specifies the
configuration of Coresight PMon devices in the system. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 sd 01/20/19
First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/pmonpsv/src/xpmonpsv_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmonpsv_hw.h @addtogroup
pmonpsv_v1_0 @{ This header file contains identifiers and basic driver functions
(or macros) that can be used to access the Performance Monitor. Refer to the
device specification for more information about this driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 sd 01/20/19
First release </pre>

FILES:
XilinxProcessorIPLib/drivers/pmonpsv/src/xpmonpsv_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmonpsv_sint.c @addtogroup
pmonpsv_v1_0 @{ This file contains the implementation of the XpsvPmon driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.0 sd 01/20/19 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/pmonpsv/src/xpmonpsv_sint.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes --- ---- ------------ 1.0 ms 07/18/2016 First release 1.1 ms 04/18/17
Modified tcl file to add suffix U for all macros definitions of prc in
xparameters.h ms 08/01/17 Added a new parameter "Cp_Compression" in Peripheral,
canonical definitions of xparameters.h and also in xprc_g.c. Modified version
from prc_v1_1 to prc_v1_2 as api.tcl which is source for prc.tcl got updated.
1.2 Nava 29/03/19 Updated the tcl logic to generated the XPrc_ConfigTable
properly. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/prc/data/prc.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprc_example.c This file
contains an example using the XPrc driver to test the registers on the device.
@note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ---- -----
------------ 1.0 ms 07/18/2016 First Release ms 04/05/2017 Modified comment
lines notation in functions to avoid unnecessary description displayed while
generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prc/examples/xprc_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprc_selftest_example.c This
file contains a design example using the PRC driver (XPrc) to do self test on
the device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----
---- ------------ 1.0 ms 07/18/2016 First release ms 04/05/2017 Modified comment
lines notation in functions to avoid unnecessary description displayed while
generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prc/examples/xprc_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprc.c @addtogroup prc_v1_2 @{
This file contains the required functions for the XPrc driver. Refer xprc.h for
a detailed description of the driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- ----- ------------ 1.0 ms 07/18/2016 First release 1.1 ms 08/01/17
Added a new parameter "Cp_Compression" in "XPrc_CfgInitialize" function. Added
new status error macros in function "XPrc_PrintVsmStatus". 1.2 Nava 29/03/19
Updated the tcl logic to generated the XPrc_ConfigTable properly. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/prc/src/xprc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprc.h @addtogroup prc_v1_2 @{
@details Xilinx PRC driver component provides management function for self-
controlling partially reconfigurable designs. It is intended for enclosed
systems where all of the Reconfigurable Modules are known to the controller. The
optional AXI4-Lite register interface allows the core to be reconfigured at run
time, so it can also be used in systems where the Reconfigurable Modules(RM) can
change in the field. The PRC supports the following features: - 32 Virtual
Sockets. - 128 Reconfigurable modules per Virtual Socket. - Optional hardware
and software shutdown of Reconfigurable Modules (configurable per Reconfigurable
Module). - Optional software start-up of Reconfigurable Modules (configurable
per Reconfigurable Module). - Optional reset of Reconfigurable Modules after
loading (configurable per Reconfigurable Module). - Virtual Socket Managers can
be shutdown and restarted by the user to allow external controllers to partially
reconfigure the device. - User control of Virtual Socket Manager output signals
is supported in the shutdown state. The Partial Reconfiguration Controller
consists of one or more Virtual Socket Managers(VSMs) which connect to a single
fetch path. Virtual Socket Managers operate in parallel waiting for triggers to
occur. When a trigger occurs, the appropriate VSM maps the trigger to an RM and
manages the reconfiguration of that RM. VSM's queue for access to the fetch
path. VSMs exist in two States - Active State - Shutdown State <b>Initialization
& Configuration</b> The XPrc_Config structure is used by the driver to configure
itself. This configuration structure is created based on HW build properties. To
support multiple runtime loading and initialization strategies employed by
various operating systems, the driver instance can be initialized in the
following way: - XPrc_LookupConfig(DeviceId) - Use the device identifier to find
the static configuration structure defined in xprc_g.c. This is setup by the
tools. For some operating systems the config structure will be initialized by
the software and this call is not needed. - XPrc_CfgInitialize(InstancePtr,
CfgPtr, EffectiveAddr) is used for initialization. The user needs to first call
the XPrc_LookupConfig() API which returns the Configuration structure pointer
which is passed as a parameter to the XPrc_CfgInitialize() API. <b> Threads </b>
This driver is not thread safe. Any needs for threads or thread mutual exclusion
must be satisfied by the layer above this driver. <b> Asserts </b> Asserts are
used within all Xilinx drivers to enforce constraints on argument values.
Asserts can be turned off on a system-wide basis by defining, at compile time,
the NDEBUG identifier. By default, asserts are turned on and it is recommended
that users leave asserts on during development. <b> Building the driver </b> The
XPrc driver is composed of several source files. This allows the user to build
and link only those parts of the driver that are necessary. <b> Debug prints
</b> XPrc driver is having debug prints. - To get the debug print statements of
the driver, please define XPRC_DEBUG as shown below. "define XPRC_DEBUG" - To
get the debug print statements of the core, please define XPRC_DEBUG_CORE as
shown below. "define XPRC_DEBUG_CORE" <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- ----- ------------ 1.0 ms 07/18/2016 First release ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. ms 04/05/2017
Modified comment lines notation in functions of prc examples to avoid
unnecessary description which was displayed while generating doxygen. 1.1 ms
04/18/17 Modified tcl file to add suffix U for all macros definitions of prc in
xparameters.h ms 08/01/17 Added a new parameter "Cp_Compression" to XPrc_Config
structure and also inline function related to this paramter. Modified xprc.c,
prc.tcl, xprc_hw.h to add a new parameter "Cp_Compression" and status error
flags. Added the Updated api.tcl to data folder. 1.2 Nava 29/03/19 Updated the
tcl logic to generated the XPrc_ConfigTable properly. </pre>

FILES:
XilinxProcessorIPLib/drivers/prc/src/xprc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprc_hw.h @addtogroup prc_v1_2
@{ This header file contains identifiers and register-level driver functions (or
macros) that can be used to access the PRC. <pre> MODIFICATION HISTORY: Ver Who
Date Changes --- ---- ------------ 1.0 ms 07/18/2016 First release 1.1 ms
08/01/17 Defined "XPRC_SR_DECOMPRESS_BAD_FORMAT_ERROR" and
"XPRC_SR_DECOMPRESS_BAD_SIZE_ERROR" status error macros and modified the value
of macro "XPRC_SR_BS_COMPATIBLE_ERROR". 1.2 Nava 29/03/19 Updated the tcl logic
to generated the XPrc_ConfigTable properly. </pre>

FILES:
XilinxProcessorIPLib/drivers/prc/src/xprc_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprc_selftest.c @addtogroup
prc_v1_2 @{ This file contains the self-test functions for the XPrc driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----- ----------- 1.0 ms
07/18/2016 First release. 1.2 Nava 29/03/19 Updated the tcl logic to generated
the XPrc_ConfigTable properly. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prc/src/xprc_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprc_sinit.c @addtogroup
prc_v1_2 @{ This file contains the implementation of the XPrc driver's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- ---- ------------ 1.0 ms 07/18/2016 First release 1.2 Nava 29/03/19 Updated
the tcl logic to generated the XPrc_ConfigTable properly. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prc/src/xprc_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- ---------- 1.0 ms 07/14/16 FirstRelease 1.1 ms 01/16/17
Updated the parameter naming from XPAR_PR_DECOUPLER_NUM_INSTANCES to
XPAR_XPRD_NUM_INSTANCES to avoid compilation failure for
XPAR_PR_DECOUPLER_NUM_INSTANCES as the tools are generating
XPAR_XPRD_NUM_INSTANCES in the generated xprd_g.c for fixing MISRA-C files. This
is a fix for CR-966099 based on the update in the tools. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/prd/data/prd.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprd_example.c This file
contains an example using the XPrd driver to test the registers on the device.
@note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ---- -----
------------ 1.0 ms 07/14/2016 First Release ms 04/05/2017 Modified comment
lines notation in functions to avoid unnecessary description displayed while
generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prd/examples/xprd_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprd_selftest_example.c This
file contains a design example using the PR Decoupler driver to do self test on
the device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----
---- ------------ 1.00 ms 7/14/2016 First release ms 04/05/2017 Modified comment
lines notation in functions to avoid unnecessary description displayed while
generating doxygen. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prd/examples/xprd_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprd.c @addtogroup prd_v1_1 @{
This file contains the implementation of the interface functions for the XPrd
driver. Refer xprd.h for a detailed description of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes --- ----- ---------- 1.0 ms
07/14/2016 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prd/src/xprd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprd.h @addtogroup prd_v1_1 @{
@details The Xilinx Partial Reconfiguration Decoupler driver can be used to
provide a boundary between the static logic and a Reconfigurable Partition
during Partial Reconfiguration. The PR Decoupler supports the following
features: - All Interface types registered in the Vivado Design Suite are
supported, including custom interfaces. - Non-Vivado Design Suite interfaces are
supported. - The decoupling behaviour can be configured for each interface. -
Each interface can have Clock Domain Crossing support. - Optional AXI4-Stream
based control. - Optional AXI4-Stream based Status. - Optional AXI4-Lite based
status and control. <b> Initialization and Configuration </b> -
XPrd_LookupConfig(DeviceId) - Use the device identifier to find the static
configuration structure defined in xprd_g.c. This is setup by the tools. For
some operating systems the config structure will be initialized by the software
and this call is not needed. - XPrd_CfgInitialize() is used for initialisation.
The user needs to first call the XPrd_LookupConfig() which returns the
Configuration structure pointer which is passed as a parameter to the
XPrd_CfgInitialize(). <b> Threads </b> This driver is not thread safe. Any needs
for threads or thread mutual exclusion must be satisfied by the layer above this
driver. <b> Asserts </b> Asserts are used within all Xilinx drivers to enforce
constraints on argument values. Asserts can be turned off on a system-wide basis
by defining, at compile time, the NDEBUG identifier. By default, asserts are
turned on and it is recommended that users leave asserts on during development.
<b> Building the driver </b> The XPrd driver is composed of several source
files. This allows the user to build and link only those parts of the driver
that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
----------- 1.0 ms 07/14/16 First release 1.1 ms 01/16/17 Updated the parameter
naming from XPAR_PR_DECOUPLER_NUM_INSTANCES to XPAR_XPRD_NUM_INSTANCES to avoid
compilation failure for XPAR_PR_DECOUPLER_NUM_INSTANCES as the tools are
generating XPAR_XPRD_NUM_INSTANCES in the generated xprd_g.c for fixing MISRA-C
files. This is a fix for CR-966099 based on the update in the tools. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. ms 04/05/2017
Modified comment lines notation in functions of prd examples to avoid
unnecessary description which was displayed while generating doxygen. </pre>

FILES:
XilinxProcessorIPLib/drivers/prd/src/xprd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprd_hw.h @addtogroup prd_v1_1
@{ This header file contains the identifiers and basic driver functions (or
macros) that can be used to access the Xilinx PR Decoupler. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ----- ----------- 1.0 ms 07/14/2016 First
release </pre>

FILES:
XilinxProcessorIPLib/drivers/prd/src/xprd_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprd_selftest.c @addtogroup
prd_v1_1 @{ This file contains the self-test functions for the XPrd driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- ----------- 1.0 ms
07/14/2016 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prd/src/xprd_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xprd_sinit.c @addtogroup
prd_v1_1 @{ This file contains the implementation of the XPrd driver's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ----- ----------- 1.0 ms 07/14/16 First release 1.1 ms 01/16/17 Updated
the parameter naming from XPAR_PR_DECOUPLER_NUM_INSTANCES to
XPAR_XPRD_NUM_INSTANCES to avoid compilation failure for
XPAR_PR_DECOUPLER_NUM_INSTANCES as the tools are generating
XPAR_XPRD_NUM_INSTANCES in the generated xprd_g.c for fixing MISRA-C files. This
is a fix for CR-966099 based on the update in the tools. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/prd/src/xprd_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 11/22/11 Created 2.02a hk 26/03/13 Added
C_QSPI_MODE 3.4 nsk 31/07/17 Added C_QSPI_BUS_WIDTH uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/qspips/data/qspips.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0
: MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/qspips/data/qspips_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xqspips_dual_flash_lqspi_example.c This file contains a design example using the
QSPI driver (XQspiPs) in Linear QSPI mode, with two serial FLASH devices on
separate buses. With two flash memories on separate buses, even numbered bits in
data words are written to the lower memory and odd numbered bits are written to
the upper memory. This example writes to the two flash memories in QSPI mode and
reads the data back from the flash memories, in Linear QSPI mode. It is
recommended to use Manual CS + Auto start for best performance. The hardware
which this example runs on, must have a serial FLASH (Numonyx N25Q, Winbond
W25Q, Spansion S25FL, ISSI IS25WP) for it to run. This example has been tested
with the Numonyx Serial Flash (N25Q128) and IS25WP series flash parts. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00
sdm 11/25/10 First release 2.00a kka 22/08/12 Updated the example as
XQspiPs_PolledTransfer API has changed. Changed the prescalar to use divide by
8. The user can change the prescalar to a maximum of divide by 2 based on the
reference clock in the system. Set the Holdb_dr bit in the configuration
register using XQSPIPS_HOLD_B_DRIVE_OPTION. Setting this bit drives the HOLD bit
of the QSPI controller. This is required for QSPI to be used in Non QSPI boot
mode else there needs to be an external pullup on this line. ms 04/05/17
Modified Comment lines in functions to recognize it as documentation block for
doxygen generation. 3.5 tjs 07/16/18 Added support for low density ISSI flash
parts. Added FlashQuadEnable API to enable quad mode in flash. Added FlashReadID
API to read and identify the flash. 3.6 akm 04/15/19 Modified FlashQuadEnable,
FlashWrie and FlashErase APIs, to wait for the on going operation to complete
before performing the next operation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/examples/xqspips_dual_flash_lqspi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xqspips_dual_flash_stack_lqspi_example.c This file contains a design example
using the QSPI driver (XQspiPs) in Linear QSPI mode, with two serial Flash
devices in stacked mode. One flash s accessed at a time on a common bus by using
separate selects. This example writes to the two flash memories in QSPI mode and
reads the data back from the flash memories, in Linear QSPI mode. It is
recommended to use Manual CS + Auto start for best performance. The hardware
which this example runs on, must have a serial Flash (Numonyx N25Q, Winbond
W25Q, Spansion S25FL, ISSI IS25WP) for it to run. This example has been tested
with the Numonyx Serial Flash (N25Q128) and IS25WP series flash parts. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 2.02a
hk 05/07/13 First release ms 04/05/17 Modified Comment lines in functions to
recognize it as documentation block and modified filename tag to include the
file in doxygen examples. 3.5 tjs 07/16/18 Added support for low density ISSI
flash parts. Added FlashQuadEnable API to enable quad mode in flash. Added
FlashReadID API to read and identify the flash. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/examples/xqspips_dual_flash_stack_lqspi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_flash_intr_example.c
This file contains a design example using the QSPI driver (XQspiPs) in interrupt
mode with a serial FLASH device. This examples performs some transfers in Manual
Chip Select and Start mode. It is recommended to use Manual CS + Auto start for
best performance. The hardware which this example runs on, must have a serial
FLASH (Numonyx N25Q, Winbond W25Q, Spansion S25FL, ISSI IS25WP) for it to run.
This example has been tested with the Numonyx Serial Flash (N25Q128) and IS25WP
series flash parts. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.00 sdm 11/25/10 First release 1.01 srt 06/12/12 Changed to
meet frequency requirements of READ command for CR 663787 2.00a kka 22/08/12
Updated the example as XQspiPs_Transfer API has changed. Changed the prescalar
to use divide by 8. The user can change the prescalar to a maximum of divide by
2 based on the reference clock in the system. Set the Holdb_dr bit in the
configuration register using XQSPIPS_HOLD_B_DRIVE_OPTION. Setting this bit
drives the HOLD bit of the QSPI controller. This is required for QSPI to be used
in Non QSPI boot mode else there needs to be an external pullup on this line.
See http://www.xilinx.com/support/answers/47596.htm 2.01a sg 02/03/13 Created a
function FlashReadID. Removed multiple initialization using SetOptions. ms
04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation. 3.5 tjs 07/16/18 Added support for low density
ISSI flash parts. Added FlashQuadEnable API to enable quad mode in flash. 3.6
akm 04/15/19 Modified FlashQuadEnable, FlashWrie and FlashErase APIs, to wait
for the on going operation to complete before performing the next operation.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/examples/xqspips_flash_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_flash_lqspi_example.c
This file contains a design example using the QSPI driver (XQspiPs) in Linear
QSPI mode with a serial FLASH device. The example writes to the flash in QSPI
mode and reads it back in Linear QSPI mode. This examples performs some
transfers in Auto mode and Manual start mode, to illustrate the modes available.
It is recommended to use Manual CS + Auto start for best performance. The
hardware which this example runs on, must have a serial FLASH (Numonyx N25Q,
Winbond W25Q, Spansion S25FL, ISSI IS25WP) for it to run. This example has been
tested with the Numonyx Serial Flash (N25Q128) and IS25WP series flash parts.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.00 sdm 11/25/10 First release 2.00a kka 22/08/12 Updated the example as
XQspiPs_PolledTransfer API has changed. Changed the prescalar to use divide by
8. The user can change the prescalar to a maximum of divide by 2 based on the
reference clock in the system. Set the Holdb_dr bit in the configuration
register using XQSPIPS_HOLD_B_DRIVE_OPTION. Setting this bit drives the HOLD bit
of the QSPI controller. This is required for QSPI to be used in Non QSPI boot
mode else there needs to be an external pullup on this line. See
http://www.xilinx.com/support/answers/47596.htm 2.01a sg 02/03/13 Created a
function FlashReadID. ms 04/05/17 Modified Comment lines in functions to
recognize it as documentation block for doxygen generation. 3.5 tjs 07/16/18
Added support for low density ISSI flash parts. Added FlashQuadEnable API to
enable quad mode in flash. 3.6 akm 04/15/19 Modified FlashQuadEnable, FlashWrie
and FlashErase APIs, to wait for the on going operation to complete before
performing the next operation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/examples/xqspips_flash_lqspi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_flash_polled_example.c
This file contains a design example using the QSPI driver (XQspiPs) in polled
mode with a serial FLASH device. This examples performs some transfers in Auto
mode and Manual start mode, to illustrate the modes available. It is recommended
to use Manual CS + Auto start for best performance. The hardware which this
example runs on. must have a serial FLASH (Numonyx N25Q, Winbond W25Q, Spansion
S25FL, ISSI IS25WP) for it to run. This example has been tested with the Numonyx
Serial Flash (N25Q128) and IS25WP series flash parts. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00 sdm 11/25/10
First release 1.01 srt 06/12/12 Changed to meet frequency requirements of READ
command for CR 663787 2.00a kka 22/08/12 Updated the example as
XQspiPs_PolledTransfer API has changed. Changed the prescalar to use divide by
8. The user can change the prescalar to a maximum of divide by 2 based on the
reference clock in the system. Set the Holdb_dr bit in the configuration
register using XQSPIPS_HOLD_B_DRIVE_OPTION. Setting this bit drives the HOLD bit
of the QSPI controller. This is required for QSPI to be used in Non QSPI boot
mode else there needs to be an external pullup on this line. See
http://www.xilinx.com/support/answers/47596.htm. 2.01a sg 02/03/13 Created a
function FlashReadID. Removed multiple initialization using SetOptions. ms
04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation. 3.5 tjs 07/16/18 Added support for low density
ISSI flash parts. Added FlashQuadEnable API to enable quad mode in flash. 3.6
akm 04/15/19 Modified FlashQuadEnable, FlashWrie and FlashErase APIs, to wait
for the on going operation to complete before performing the next operation.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/examples/xqspips_flash_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_g128_flash_example.c
This file contains a design example using the QSPI driver (XQspiPs) with a
serial Flash device greater than 128Mb. The example writes to flash and reads it
back in I/O mode. This examples performs some transfers in Auto mode and Manual
start mode, to illustrate the modes available. It is recommended to use Manual
CS + Auto start for best performance. This example illustrates single, parallel
and stacked modes. Both the flash devices have to be of the same make and size.
The hardware which this example runs on, must have a serial Flash (Micron N25Q
or Spansion S25FL) for it to run. This example has been tested with the Micron
Serial Flash (N25Q256, N25Q512 & N25Q00AA) and Spansion (S25FL256 & S25FL512)
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
2.02a hk 05/07/13 First release raw 12/10/15 Added support for Macronix 256Mb
and 1Gb flash parts ms 04/05/17 Modified Comment lines in functions to recognize
it as documentation block for doxygen generation. tjs 06/16/17 Added support for
IS25LP256D flash part (PR-4650) </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/examples/xqspips_g128_flash_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_selftest_example.c This
file contains an example for using the QSPI Hardware, it does a simple hardware
connection check. @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 drg/jz 01/25/10 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/examples/xqspips_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips.c @addtogroup
qspips_v3_6 @{ Contains implements the interface functions of the XQspiPs
driver. See xqspips.h for a detailed description of the device and driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00 sdm 11/25/10
First release 2.00a kka 07/25/12 Removed XQspiPs_GetWriteData API. The
XQspiPs_SetSlaveSelect has been modified to remove the argument of the slave
select as the QSPI controller only supports one slave. XQspiPs_GetSlaveSelect
API has been removed Added logic to XQspiPs_GetReadData to handle data shift for
normal data reads and instruction/status reads differently based on the
ShiftReadData flag. Removed the selection for the following options: Master mode
(XQSPIPS_MASTER_OPTION) and Flash interface mode (XQSPIPS_FLASH_MODE_OPTION)
option as the QSPI driver supports the Master mode and Flash Interface mode and
doesnot support Slave mode or the legacy mode. Modified the
XQspiPs_PolledTransfer and XQspiPs_Transfer APIs so that the last argument
(IsInst) specifying whether it is instruction or data has been removed. The
first byte in the SendBufPtr argument of these APIs specify the instruction to
be sent to the Flash Device. The XQspiPs_PolledTransfer function has been
updated to fill the data to fifo depth. This version of the driver fixes CRs
670197/663787. 2.01a sg 02/03/13 Added flash opcodes for
DUAL_IO_READ,QUAD_IO_READ. Created macros XQspiPs_IsManualStart and
XQspiPs_IsManualChipSelect. Changed QSPI transfer logic for polled and interrupt
modes to be based on filled tx fifo count and receive based on it. RXNEMPTY
interrupt is not used. Added assertions to XQspiPs_LqspiRead function. 2.02a hk
05/14/13 Added enable and disable to the XQspiPs_LqspiRead() function Added
instructions for bank selection, die erase and flag status register to the flash
instruction table Handling for instructions not in flash instruction table
added. Checking for Tx FIFO empty when switching from TXD1/2/3 to TXD0 added. If
WRSR instruction is sent with byte count 3 (spansion), instruction size and TXD
register changed accordingly. CR 712502 and 703869. Added (ifdef linear base
address) in the Linear read function. Changed XPAR_XQSPIPS_0_LINEAR_BASEADDR to
XPAR_PS7_QSPI_LINEAR_0_S_AXI_BASEADDR in XQspiPs_LqspiRead function. Fix for
CR718141 2.03a hk 09/05/13 Modified polled and interrupt transfers to make use
of thresholds. This is to improve performance. Added RX and TX threshold reset
to one in XQspiPs_Abort. Added RX threshold reset(1) after transfer in polled
and interrupt transfers. Made changes to make sure threshold change is done only
when no transfer is in progress. 3.1 hk 08/13/14 When writing to the
configuration register, set/reset required bits leaving reserved bits untouched.
CR 796813. 3.2 sk 02/05/15 Add SLCR reset in abort function as a workaround
because controller does not update FIFO status flags as expected when thresholds
are used. 3.3 sk 11/07/15 Modified the API prototypes according to MISRAC
standards to remove compilation warnings. CR 868893. 3.5 tjs 13/08/18 Fixed
compilation warnings for ARMCC. 3.6 akm 03/28/19 Fixed memory leak issue while
reading from qspi.(CR1016357) 3.6 akm 04/15/19 Modified the mask in
XQspiPs_GetReadData() API to retrieve configuration register values of both the
Flashes in dual parellel connection. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips.h @addtogroup
qspips_v3_6 @{ @details This file contains the implementation of the XQspiPs
driver. It supports only master mode. User documentation for the driver
functions is contained in this file in the form of comment blocks at the front
of each function. A QSPI device connects to an QSPI bus through a 4-wire serial
interface. The QSPI bus is a full-duplex, synchronous bus that facilitates
communication between one master and one slave. The device is always full-
duplex, which means that for every byte sent, one is received, and vice-versa.
The master controls the clock, so it can regulate when it wants to send or
receive data. The slave is under control of the master, it must respond quickly
since it has no control of the clock and must send/receive data as fast or as
slow as the master does. <b> Linear Mode </b> The Linear Quad-SPI Controller
extends the existing Quad-SPI Controller�s functionality by adding a linear
addressing scheme that allows the SPI flash memory subsystem to behave like a
typical ROM device. The new feature hides the normal SPI protocol from a master
reading from the SPI flash memory. The feature improves both the user
friendliness and the overall read memory throughput over that of the current
Quad-SPI Controller by lessening the amount of software overheads required and
by the use of the faster AXI interface. <b>Initialization & Configuration</b>
The XQspiPs_Config structure is used by the driver to configure itself. This
configuration structure is typically created by the tool-chain based on HW build
properties. To support multiple runtime loading and initialization strategies
employed by various operating systems, the driver instance can be initialized in
the following way: - XQspiPs_LookupConfig(DeviceId) - Use the device identifier
to find static configuration structure defined in xqspips_g.c. This is setup by
the tools. For some operating systems the config structure will be initialized
by the software and this call is not needed. -
XQspiPs_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) - Uses a configuration
structure provided by the caller. If running in a system with address
translation, the provided virtual memory base address replaces the physical
address present in the configuration structure. <b>Multiple Masters</b> More
than one master can exist, but arbitration is the responsibility of the higher
layer software. The device driver does not perform any type of arbitration.
<b>Modes of Operation</b> There are four modes to perform a data transfer and
the selection of a mode is based on Chip Select(CS) and Start. These two options
individually, can be controlled either by software(Manual) or hardware(Auto). -
Auto CS: Chip select is automatically asserted as soon as the first word is
written into the TXFIFO and de asserted when the TXFIFO becomes empty - Manual
CS: Software must assert and de assert CS. - Auto Start: Data transmission
starts as soon as there is data in the TXFIFO and stalls when the TXFIFO is
empty - Manual Start: Software must start data transmission at the beginning of
the transaction or whenever the TXFIFO has become empty The preferred
combination is Manual CS and Auto Start. In this combination, the software
asserts CS before loading any data into TXFIFO. In Auto Start mode, whenever
data is in TXFIFO, controller sends it out until TXFIFO becomes empty. The
software reads the RXFIFO whenever the data is available. If no further data,
software disables CS. Risks/challenges of other combinations: - Manual CS and
Manual Start: Manual Start bit should be set after each TXFIFO write otherwise
there could be a race condition where the TXFIFO becomes empty before the new
word is written. In that case the transmission stops. - Auto CS with Manual or
Auto Start: It is very difficult for software to keep the TXFIFO filled.
Whenever the TXFIFO runs empty, CS is de asserted. This results in a single
transaction to be split into multiple pieces each with its own chip select. This
will result in garbage data to be sent. <b>Interrupts</b> The user must connect
the interrupt handler of the driver, XQspiPs_InterruptHandler, to an interrupt
system such that it will be called when an interrupt occurs. This function does
not save and restore the processor context such that the user must provide this
processing. The driver handles the following interrupts: - Data Transmit
Register/FIFO Underflow - Data Receive Register/FIFO Not Empty - Data Transmit
Register/FIFO Overwater - Data Receive Register/FIFO Overrun The Data Transmit
Register/FIFO Overwater interrupt -- indicates that the QSPI device has
transmitted the data available to transmit, and now its data register and FIFO
is ready to accept more data. The driver uses this interrupt to indicate
progress while sending data. The driver may have more data to send, in which
case the data transmit register and FIFO is filled for subsequent transmission.
When this interrupt arrives and all the data has been sent, the driver invokes
the status callback with a value of XST_SPI_TRANSFER_DONE to inform the upper
layer software that all data has been sent. The Data Transmit Register/FIFO
Underflow interrupt -- indicates that, as slave, the QSPI device was required to
transmit but there was no data available to transmit in the transmit register
(or FIFO). This may not be an error if the master is not expecting data. But in
the case where the master is expecting data, this serves as a notification of
such a condition. The driver reports this condition to the upper layer software
through the status handler. The Data Receive Register/FIFO Overrun interrupt --
indicates that the QSPI device received data and subsequently dropped the data
because the data receive register and FIFO was full. The driver reports this
condition to the upper layer software through the status handler. This likely
indicates a problem with the higher layer protocol, or a problem with the slave
performance. <b>Polled Operation</b> Transfer in polled mode is supported
through a separate interface function XQspiPs_PolledTransfer(). Unlike the
transfer function in the interrupt mode, this function blocks until all data has
been sent/received. <b>Device Busy</b> Some operations are disallowed when the
device is busy. The driver tracks whether a device is busy. The device is
considered busy when a data transfer request is outstanding, and is considered
not busy only when that transfer completes (or is aborted with a mode fault
error). <b>Device Configuration</b> The device can be configured in various ways
during the FPGA implementation process. Configuration parameters are stored in
the xqspips_g.c file or passed in via XQspiPs_CfgInitialize(). A table is
defined where each entry contains configuration information for an QSPI device,
including the base address for the device. <b>RTOS Independence</b> This driver
is intended to be RTOS and processor independent. It works with physical
addresses only. Any needs for dynamic memory management, threads or thread
mutual exclusion, virtual memory, or cache control must be satisfied by the
layer above this driver. NOTE: This driver was always tested with endianness set
to little-endian. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a sdm 11/25/10 First release, based on the PS SPI driver... 1.01a
sdm 11/22/11 Added TCL file for generating QSPI parameters in xparameters.h
2.00a kka 07/25/12 Added a few register defines for CR 670297 Removed code
related to mode fault for CR 671468 The XQspiPs_SetSlaveSelect has been modified
to remove the argument of the slave select as the QSPI controller only supports
one slave. XQspiPs_GetSlaveSelect API has been removed Added a flag
ShiftReadData to the instance structure . and is used in the XQspiPs_GetReadData
API. The ShiftReadData Flag indicates whether the data read from the Rx FIFO
needs to be shifted in cases where the data is less than 4 bytes Removed the
selection for the following options: Master mode (XQSPIPS_MASTER_OPTION) and
Flash interface mode (XQSPIPS_FLASH_MODE_OPTION) option as the QSPI driver
supports the Master mode and Flash Interface mode and doesnot support Slave mode
or the legacy mode. Modified the XQspiPs_PolledTransfer and XQspiPs_Transfer
APIs so that the last argument (IsInst) specifying whether it is instruction or
data has been removed. The first byte in the SendBufPtr argument of these APIs
specify the instruction to be sent to the Flash Device. This version of the
driver fixes CRs 670197/663787/ 670297/671468. Added the option for setting the
Holdb_dr bit in the configuration options, XQSPIPS_HOLD_B_DRIVE_OPTION is the
option to be used for setting this bit in the configuration register. The
XQspiPs_PolledTransfer function has been updated to fill the data to fifo depth.
2.01a sg 02/03/13 Added flash opcodes for DUAL_IO_READ,QUAD_IO_READ. Added
macros for Set/Get Rx Watermark. Changed QSPI Enable/Disable macro argument from
BaseAddress to Instance Pointer. Added DelayNss argument to SetDelays and
GetDelays API's. Created macros XQspiPs_IsManualStart and
XQspiPs_IsManualChipSelect. Changed QSPI transfer logic for polled and interrupt
modes to be based on filled tx fifo count and receive based on it. RXNEMPTY
interrupt is not used. Added assertions to XQspiPs_LqspiRead function. SetDelays
and GetDelays API's include DelayNss parameter. Added defines for DelayNss,Rx
Watermark,Interrupts which need write to clear. Removed Read zeros mask from
LQSPI Config register. Renamed Fixed burst error to data FSM error in LQSPI
Status register. 2.02a hk 05/07/13 Added ConnectionMode to config structure.
Corresponds to C_QSPI_MODE - 0:Single, 1:Stacked, 2:Parallel Added enable and
disable to the XQspiPs_LqspiRead() function Removed XQspi_Reset() in
Set_Options() function when LQSPI_MODE_OPTION is set. Added instructions for
bank selection, die erase and flag status register to the flash instruction
table Handling for instructions not in flash instruction table added. Checking
for Tx FIFO empty when switching from TXD1/2/3 to TXD0 added. If WRSR
instruction is sent with byte count 3 (spansion), instruction size and TXD
register changed accordingly. CR 712502 and 703869. Added prefix to constant
definitions for ConnectionMode Added (ifdef linear base address) in the Linear
read function. Changed XPAR_XQSPIPS_0_LINEAR_BASEADDR to
XPAR_PS7_QSPI_LINEAR_0_S_AXI_BASEADDR in XQspiPs_LqspiRead function. Fix for
CR718141. 2.03a hk 09/17/13 Modified polled and interrupt transfers to make use
of thresholds. This is to improve performance. Added API's for QSPI reset and
linear mode initialization for boot. Added RX and TX threshold reset to one in
XQspiPs_Abort. Added RX threshold reset(1) after transfer in polled and
interrupt transfers. Made changes to make sure threshold change is done only
when no transfer is in progress. Updated linear init API for parallel and
stacked modes. CR737760. 3.1 hk 08/13/14 When writing to the configuration
register, set/reset required bits leaving reserved bits untouched. CR 796813.
3.2 sk 02/05/15 Add SLCR reset in abort function as a workaround because
controller does not update FIFO status flags as expected when thresholds are
used. 3.3 sk 11/07/15 Modified the API prototypes according to MISRAC standards
to remove compilation warnings. CR 868893. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/05/17 Modified Comment lines in
functions of qspips examples to recognize it as documentation block and modified
filename tag in xqspips_dual_flash_stack_lqspi_example.c to include it in
doxygen examples. 3.4 nsk 31/07/17 Added QSPI_BUS_WIDTH parameter in
xparameters.h file 3.5 tjs 08/21/18 Fixed compilation warnings for the ARMCC.
3.5 tjs 07/16/18 Added support for low density ISSI flash parts. 3.6 akm
03/28/19 Fixed memory leak issue while reading from qspi.(CR1016357) 3.6 akm
04/15/19 Modified FlashQuadEnable, FlashWrie and FlashErase APIs, to wait for
the on going operation to complete before performing the next operation. 3.6 akm
04/15/19 Modified the mask in XQspiPs_GetReadData() API to retrieve
configuration register values of both the Flashes in dual parellel connection.
</pre>

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_g.c @addtogroup
qspips_v3_6 @{ This file contains a configuration table that specifies the
configuration of QSPI devices in the system. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- --- -------- 1.00 sdm 11/25/10 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_hw.c @addtogroup
qspips_v3_6 @{ Contains low level functions, primarily reset related. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 2.03a hk 09/17/13
First release 3.1 hk 06/19/14 When writing to the configuration register,
set/reset required bits leaving reserved bits untouched. CR 796813. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_hw.h @addtogroup
qspips_v3_6 @{ This header file contains the identifiers and basic HW access
driver functions (or macros) that can be used to access the device. Other driver
functions are defined in xqspips.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00 sdm 11/25/10 First release 2.00a ka 07/25/12
Added a few register defines for CR 670297 and removed some defines of reserved
fields for CR 671468 Added define XQSPIPS_CR_HOLD_B_MASK for Holdb_dr bit in
Configuration register. 2.01a sg 02/03/13 Added defines for DelayNss,Rx
Watermark,Interrupts which need write to clear. Removed Read zeros mask from
LQSPI Config register. 2.03a hk 08/22/13 Added prototypes of API's for QSPI
reset and linear mode initialization for boot. Added related constant
definitions. 3.1 hk 08/13/14 Changed definition of CR reset value masks to
set/reset required bits leaving reserved bits untouched. CR 796813. 3.2 sk
02/05/15 Add SLCR reset in abort function as a workaround because controller
does not update FIFO status flags as expected when thresholds are used. 3.6 akm
03/28/19 Fixed memory leak issue while reading from qspi.(CR1016357) </pre>

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_options.c @addtogroup
qspips_v3_6 @{ Contains functions for the configuration of the XQspiPs driver
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.00 sdm 11/25/10 First release 2.00a kka 07/25/12 Removed the selection for the
following options: Master mode (XQSPIPS_MASTER_OPTION) and Flash interface mode
(XQSPIPS_FLASH_MODE_OPTION) option as the QSPI driver supports the Master mode
and Flash Interface mode. The driver doesnot support Slave mode or the legacy
mode. Added the option for setting the Holdb_dr bit in the configuration
options, XQSPIPS_HOLD_B_DRIVE_OPTION is the option to be used for setting this
bit in the configuration register. 2.01a sg 02/03/13 SetDelays and GetDelays
API's include DelayNss parameter. 2.02a hk 26/03/13 Removed XQspi_Reset() in
Set_Options() function when LQSPI_MODE_OPTION is set. Moved Enable() to
XQpsiPs_LqspiRead(). 3.3 sk 11/07/15 Modified the API prototypes according to
MISRAC standards to remove compilation warnings. CR 868893. </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_selftest.c @addtogroup
qspips_v3_6 @{ This file contains the implementation of selftest function for
the QSPI device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00 sdm 11/25/10 First release 2.01a sg 02/03/13 Delay Register test
is added with DelayNss parameter. 3.1 hk 06/19/14 Remove checks for CR and ISR
register values as they are reset in the previous step. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspips_sinit.c @addtogroup
qspips_v3_6 @{ The implementation of the XQspiPs component's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.00 sdm 11/25/10 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspips/src/xqspips_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 hk 08/21/14 First release sk 05/06/15 Imported
Bus Width Parameter. 1.5 nsk 08/14/17 Added CCI support 1.9 mus 07/30/19 Added
CCI support for Versal at EL1 NS uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/qspipsu/data/qspipsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xqspipsu_generic_flash_interrupt_example.c This file contains a design example
using the QSPIPSU driver (XQspiPsu) with a serial Flash device greater than or
equal to 128Mb. The example writes to flash and reads it back in DMA mode. This
examples runs with GENFIFO Manual start. It runs in interrupt mode. This example
illustrates single, parallel and stacked modes. Both the flash devices have to
be of the same make and size. The hardware which this example runs on, must have
a serial Flash (Micron N25Q or Spansion S25FL) for it to run. In order to test
in single, parallel or stacked flash configurations the necessary HW must be
present and QSPI_MODE (also reflected in ConnectionMode in the instance) has to
be in sync with HW flash configuration being tested. This example has been
tested with the Micron Serial Flash (N25Q512) and ISSI Serial Flash parts of
IS25WP and IS25LP series flashes in single and parallel modes using A53 and R5
processors. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 1.0 hk 08/21/14 First release sk 06/17/15 Used Tx/Rx flags for
Transmitting/Receiving. sk 11/23/15 Added Support for Macronix 1Gb part. ms
04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation. 1.1 tjs 06/16/17 Added support for IS25LP256D
flash part (PR-4650) 1.5 tjs 09/15/17 Replaced ifdef COMMENTS to if
USE_FOUR_BYTE (CR-984966) 1.6 tjs 10/16/17 ifdef COMMENT replaced with the flow
similar to u-boot and linux for accessing flash parts with size more then 16MB
(CR-984966) 1.7 tjs 11/16/17 Removed the unsupported 4 Byte write and sector
erase commands. 1.7 tjs 12/01/17 Added support for MT25QL02G Flash from Micron.
CR-990642 1.7 tjs 12/19/17 Added support for S25FL064L from Spansion. CR-990724
1.7 tjs 01/11/18 Added support for MX66L1G45G flash from Macronix CR-992367 1.7
tjs 26/03/18 In dual parallel mode enable both CS when issuing Write enable
command. CR-998478 1.8 tjs 05/02/18 Added support for IS25LP064 and IS25WP064.
1.8 tjs 16/07/18 Added support for the low density ISSI flash parts. 1.9 akm
02/27/19 Added support for IS25LP128, IS25WP128, IS25LP256, IS25WP256,
IS25LP512, IS25WP512 Flash Devices 1.9 akm 04/03/19 Fixed data alignment
warnings on IAR compiler. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/examples/xqspipsu_generic_flash_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xqspipsu_generic_flash_lqspi_example.c This file contains a design example using
the QSPIPSU driver (XQspiPsu) with a serial Flash device greater than or equal
to 128Mb. The example writes to flash in GQSPI mode and reads it back in Linear
QSPI mode.This examples runs with GENFIFO Manual start. It runs in interrupt
mode.This example runs in single mode. The hardware which this example runs on,
must have a serial Flash (Micron N25Q or Spansion S25FL) for it to run. This
example has been tested with the Micron Serial Flash (N25Q512A) and ISSI Serial
Flash parts of IS25WP and IS25LP series flashes in single mode using A53 and R5
processors. @note In dual parallel mode flash connection, ZynqMP GQSPI writes
data in bytes(Even bytes in lower flash and odd bytes in upper flash), where as
LQSPI reads the data in bitwise. so this is causing data mismatch while reading
in LQSPI mode. so this application proceeds with single mode irrespective of
flash connection. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.0 hk 08/21/14 First release sk 06/17/15 Used Tx/Rx flags for
Transmitting/Receiving. sk 11/23/15 Added Support for Macronix 1Gb part. 1.2 nsk
07/01/16 Add LQSPI support 1.3 nsk 09/19/16 Update documentation ms 04/05/17
Modified Comment lines in functions to recognize it as documentation block and
modified filename tag to include the file in doxygen examples. 1.4 tjs 06/16/17
Added support for IS25LP256D flash part (PR-4650) 1.5 tjs 09/15/17 Replaced
ifdef COMMENTS to if USE_FOUR_BYTE (CR-984966) 1.7 tjs 11/16/17 Removed the
unsupported 4 Byte write and sector erase commands. 1.7 tjs 12/01/17 Added
support for MT25QL02G Flash from Micron. CR-990642 1.7 tjs 12/19/17 Added
support for S25FL064L from Spansion. CR-990724 1.7 tjs 01/11/18 Added support
for MX66L1G45G flash from Macronix CR-992367 1.7 tjs 26/03/18 In dual parallel
mode enable both CS when issuing Write enable command. CR-998478 1.8 tjs
05/02/18 Added support for IS25LP064 and IS25WP064. 1.8 tjs 16/07/18 Added
support for the low density ISSI flash parts. 1.8 tjs 09/14/18 Fixed compilation
warnings. 1.9 akm 02/27/19 Added support for IS25LP128, IS25WP128, IS25LP256,
IS25WP256, IS25LP512, IS25WP512 Flash Devices 1.9 akm 04/03/19 Fixed data
alignment warnings on IAR compiler. 1.9 akm 04/03/19 Fixed compilation error in
XQspiPsu_LqspiRead() function on IAR compiler. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/examples/xqspipsu_generic_flash_lqspi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xqspipsu_generic_flash_polled_64bit_dma_r5_example.c This file contains a design
example using the QSPIPSU driver (XQspiPsu) with a serial Flash device greater
than or equal to 128Mb. The example writes to flash and reads it back in 64 bit
DMA mode. As the example will be running in only 32 bit systems it cannot access
64 bit pointers directly and so for verifying the data written is correct use 64
bit processor to access the memory. This examples runs with GENFIFO Manual
start. It runs in polled mode. This example illustrates single, parallel and
stacked modes. Both the flash devices have to be of the same make and size. The
hardware which this example runs on, must have a serial Flash (Micron N25Q or
Spansion S25FL) for it to run. In order to test in single, parallel or stacked
flash configurations the necessary HW must be present and QSPI_MODE (also
reflected in ConnectionMode in the instance) has to be in sync with HW flash
configuration being tested. This example has been tested with the Micron Serial
Flash (N25Q512) and ISSI Serial Flash parts of IS25WP and IS25LP series flashes
in single and parallel modes using A53 and R5 processors. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.8 tjs 06/26/16
Added an example for accessing 64bit dma within 32 bit application. CR1004701
1.8 tjs 07/18/18 For 32 bit application RxAddress can be in the range of 64 bit
address space. (CR1006862) 1.8 tjs 16/07/18 Added support for the low density
ISSI flash parts. 1.9 akm 02/27/19 Added support for IS25LP128, IS25WP128,
IS25LP256, IS25WP256, IS25LP512, IS25WP512 Flash Devices 1.9 akm 04/03/19 Fixed
data alignment warnings on IAR compiler. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/examples/xqspipsu_generic_flash_polled_64bit_dma_r5_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xqspipsu_generic_flash_polled_example.c This file contains a design example
using the QSPIPSU driver (XQspiPsu) with a serial Flash device greater than or
equal to 128Mb. The example writes to flash and reads it back in DMA mode. This
examples runs with GENFIFO Manual start. It runs in polled mode. This example
illustrates single, parallel and stacked modes. Both the flash devices have to
be of the same make and size. The hardware which this example runs on, must have
a serial Flash (Micron N25Q or Spansion S25FL) for it to run. In order to test
in single, parallel or stacked flash configurations the necessary HW must be
present and QSPI_MODE (also reflected in ConnectionMode in the instance) has to
be in sync with HW flash configuration being tested. This example has been
tested with the Micron Serial Flash (N25Q512) and ISSI Serial Flash parts of
IS25WP and IS25LP series flashes in single and parallel modes using A53 and R5
processors. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 1.0 hk 08/21/14 First release sk 06/17/15 Used Tx/Rx flags for
Transmitting/Receiving. sk 11/23/15 Added Support for Macronix 1Gb part. ms
04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation. 1.1 tjs 06/16/17 Added support for IS25LP256D
flash part (PR-4650) 1.5 tjs 09/15/17 Replaced ifdef COMMENTS to if
USE_FOUR_BYTE (CR-984966) 1.6 tjs 10/16/17 ifdef COMMENT replaced with the flow
similar to u-boot and linux for accessing flash parts with size more then 16MB
(CR-984966) 1.7 tjs 11/16/17 Removed the unsupported 4 Byte write and sector
erase commands. 1.7 tjs 12/01/17 Added support for MT25QL02G Flash from Micron.
CR-990642 1.7 tjs 12/19/17 Added support for S25FL064L from Spansion. CR-990724
1.7 tjs 01/11/18 Added support for MX66L1G45G flash from Macronix CR-992367 1.7
tjs 26/03/18 In dual parallel mode enable both CS when issuing Write enable
command. CR-998478 1.8 tjs 05/02/18 Added support for IS25LP064 and IS25WP064.
1.8 tjs 16/07/18 Added support for the low density ISSI flash parts. 1.9 akm
02/27/19 Added support for IS25LP128, IS25WP128, IS25LP256, IS25WP256,
IS25LP512, IS25WP512 Flash Devices 1.9 akm 04/03/19 Fixed data alignment
warnings on IAR compiler. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/examples/xqspipsu_generic_flash_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xqspipsu_polldata_polltimeout_interrupt_example.c This file contains a design
example using the QSPIPSU driver (XQspiPsu) with a serial Flash device greater
than or equal to 128Mb. The example writes to flash and reads it back in DMA
mode. This examples runs with GENFIFO Manual start. It runs in interrupt mode.
This example illustrates single, parallel and stacked modes. Both the flash
devices have to be of the same make and size. The hardware which this example
runs on, must have a serial Flash (Micron N25Q or Spansion S25FL) for it to run.
In order to test in single, parallel or stacked flash configurations the
necessary HW must be present and QSPI_MODE (also reflected in ConnectionMode in
the instance) has to be in sync with HW flash configuration being tested. This
application will configure GQSPI controller to send status command to know the
flash status, instead of sending status command from the application. This
example has been tested with the Micron Serial Flash (N25Q512A) and ISSI Serial
Flash parts of IS25WP and IS25LP series flashes in single and parallel using A53
and r5 processors. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.2 nsk 08/05/16 First release 1.3 nsk 09/16/16 Update for
dual parallel configuration 1.3 nsk 09/19/16 Update documentation ms 04/05/17
Modified Comment lines in functions to recognize it as documentation block and
modified filename tag to include the file in doxygen examples. 1.4 tjs 06/16/17
Added support for IS25LP256D flash part (PR-4650) 1.5 tjs 07/20/17 Added
extended read support for MT25Q series flash (CR-980491) 1.5 tjs 09/15/17
Replaced ifdef COMMENTS to if USE_FOUR_BYTE (CR-984966) 1.7 tjs 11/16/17 Removed
the unsupported 4 Byte write and sector erase commands. 1.7 tjs 12/01/17 Added
support for MT25QL02G Flash from Micron. CR-990642 1.7 tjs 12/19/17 Added
support for S25FL064L from Spansion. CR-990724 1.7 tjs 01/11/18 Added support
for MX66L1G45G flash from Macronix CR-992367 1.7 tjs 26/03/18 In dual parallel
mode enable both CS when issuing Write enable command. CR-998478 1.8 tjs
16/07/18 Added support for the low density ISSI flash parts. 1.8 tjs 09/14/18
Fixed compilation warnings. 1.9 akm 02/27/19 Added support for IS25LP128,
IS25WP128, IS25LP256, IS25WP256, IS25LP512, IS25WP512 Flash Devices 1.9 akm
04/03/19 Fixed data alignment warnings on IAR compiler. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/examples/xqspipsu_polldata_polltimeout_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xqspipsu_write_protect_example.c This file contains a design example using the
QSPIPSU driver (XQspiPsu) with a serial Flash device greater than or equal to
128Mb. The example writes to flash and reads it back in DMA mode. This examples
runs with GENFIFO Manual start. It runs in interrupt mode. This example works
only with single mode and x1 or x2 data mode. This example will not work with x4
data mode and dual parallel or stacked configuration. The hardware which this
example runs on, must have a serial Flash (Micron N25Q or MT25Q) for it to run.
In order to test in single flash configurations the necessary HW must be present
and QSPI_MODE (also reflected in ConnectionMode in the instance) has to be in
sync with HW flash configuration being tested. This example neither set the
required MIO to control the Write Protect pin nor the driver is setting the MIO.
The MIO must be configured to be used by QSPI.This example has been tested with
the Micron Serial Flash (N25Q512) and ISSI Serial Flash parts of IS25WP and
IS25LP series flashes in single mode using A53 and R5 processors. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.7 tjs
01/25/18 Added support to toggle the WP pin of flash. (PR2448) 1.7 tjs 26/03/18
In dual parallel mode enable both CS when issuing Write enable command.
CR-998478 1.8 tjs 05/02/18 Added support for IS25LP064 and IS25WP064. 1.8 tjs
16/07/18 Added support for the low density ISSI flash parts. 1.9 akm 02/27/19
Added support for IS25LP128, IS25WP128, IS25LP256, IS25WP256, IS25LP512,
IS25WP512 Flash Devices 1.9 akm 04/03/19 Fixed data alignment warnings on IAR
compiler. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/examples/xqspipsu_write_protect_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xqspipsu.c @addtogroup
qspipsu_v1_9 @{ This file implements the functions required to use the QSPIPSU
hardware to perform a transfer. These are accessible to the user via xqspipsu.h.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.0 hk
08/21/14 First release sk 03/13/15 Added IO mode support. hk 03/18/15 Switch to
I/O mode before clearing RX FIFO. Clear and disable DMA interrupts/status in
abort. Use DMA DONE bit instead of BUSY as recommended. sk 04/24/15 Modified the
code according to MISRAC-2012. sk 06/17/15 Removed NULL checks for Rx/Tx
buffers. As writing/reading from 0x0 location is permitted. 1.1 sk 04/12/16
Added debug message prints. 1.2 nsk 07/01/16 Changed XQspiPsu_Select to support
GQSPI and LQSPI selection. rk 07/15/16 Added support for TapDelays at different
frequencies. nsk 08/05/16 Added example support PollData and PollTimeout 1.3 nsk
09/16/16 Update PollData and PollTimeout support for dual parallel
configurations, modified XQspiPsu_PollData() and
XQspiPsu_Create_PollConfigData() 1,5 nsk 08/14/17 Added CCI support 1.7 tjs
01/16/18 Removed the check for DMA MSB to be written. (CR992560) 1.7 tjs
01/17/18 Added a support to toggle WP pin of the flash. 1.7 tjs 03/14/18 Added
support in EL1 NS mode (CR974882) 1.8 tjs 06/26/18 Added an example for
accessing 64bit dma within 32 bit application. CR1004701 1.8 tjs 06/26/18
Removed checkpatch warnings. 1.8 tjs 07/09/18 Fixed cppcheck and doxygen
warnings. (CR1006336) 1.8 tjs 07/18/18 Setup64BRxDma() should be called only if
the RxAddress is greater than 32 bit address space. (CR1006862) 1.8 tjs 09/06/18
Fixed the code in XQspiPsu_GenFifoEntryData() for data transfer length up to 255
for reducing the extra loop. 1.8 mus 11/05/18 Support 64 bit DMA addresses for
Microblaze-X platform. 1.9 tjs 11/22/17 Added the check for A72 and R5
processors (CR-987075) 1.9 tjs 04/17/18 Updated register addresses as per the
latest revision of versal (CR999610) 1.9 aru 01/17/19 Fixes violations according
to MISRAC-2012 in safety mode and modified the code such as Added UNITPTR
inplace of INTPTR,Declared the pointer param as Pointer to const . 1.9 nsk
02/01/19 Clear DMA_DST_ADDR_MSB register on 32bit machine, if the address is of
only 32bit (CR1020031) 1.9 nsk 02/01/19 Added QSPI idling support. 1.9 rama
03/13/19 Fixed MISRA violations related to UR data anamoly, expression is not a
boolean 1.9 nsk 03/27/19 Update 64bit dma support </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/src/xqspipsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xqspipsu.h @addtogroup
qspipsu_v1_9 @{ @details This is the header file for the implementation of
QSPIPSU driver. Generic QSPI interface allows for communication to any QSPI
slave device. GQSPI contains a GENFIFO into which the bus transfers required are
to be pushed with appropriate configuration. The controller provides TX and RX
FIFO's and a DMA to be used for RX transfers. The controller executes each
GENFIFO entry noting the configuration and places data on the bus as required
The different options in GENFIFO are as follows: IMM_DATA : Can be one byte of
data to be transmitted, number of clocks or number of bytes in transfer.
DATA_XFER : Indicates that data/clocks need to be transmitted or received.
EXPONENT : e when 2^e bytes are involved in transfer. SPI_MODE : SPI/Dual
SPI/Quad SPI CS : Lower or Upper CS or Both Bus : Lower or Upper Bus or Both TX
: When selected, controller transmits data in IMM or fetches number of bytes
mentioned form TX FIFO. If not selected, dummies are pumped. RX : When selected,
controller receives and fills the RX FIFO/allows RX DMA of requested number of
bytes. If not selected, RX data is discarded. Stripe : Byte stripe over lower
and upper bus or not. Poll : Polls response to match for to a set value (used
along with POLL_CFG registers) and then proceeds to next GENFIFO entry. This
feature is not currently used in the driver. GENFIFO has manual and auto start
options. All DMA requests need a 4-byte aligned destination address buffer and
size of transfer should also be a multiple of 4. This driver supports DMA RX and
IO RX. Initialization: This driver uses the GQSPI controller with RX DMA. It
supports both interrupt and polled transfers. Manual start of GENFIFO is used.
XQspiPsu_CfgInitialize() initializes the instance variables. Additional setting
can be done using SetOptions/ClearOptions functions and SelectSlave function.
Transfer: Polled or Interrupt transfers can be done. The transfer function needs
the message(s) to be transmitted in the form of an array of type XQspiPsu_Msg.
This is supposed to contain the byte count and any TX/RX buffers as required.
Flags can be used indicate further information such as whether the message
should be striped. The transfer functions form and write GENFIFO entries, check
the status of the transfer and report back to the application when done. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
-----------------------------------------------. 1.0 hk 08/21/14 First release
sk 03/13/15 Added IO mode support. hk 03/18/15 Switch to I/O mode before
clearing RX FIFO. Clear and disable DMA interrupts/status in abort. Use DMA DONE
bit instead of BUSY as recommended. sk 04/24/15 Modified the code according to
MISRAC-2012. sk 06/17/15 Removed NULL checks for Rx/Tx buffers. As
writing/reading from 0x0 location is permitted. 1.1 sk 04/12/16 Added debug
message prints. 1.2 nsk 07/01/16 Added LQSPI support Modified XQspiPsu_Select()
macro in xqspipsu.h Added XQspiPsu_GetLqspiConfigReg() in xqspipsu.h Added
required macros in xqspipsu_hw.h Modified XQspiPsu_SetOptions() to support LQSPI
options and updated OptionsTable in xqspipsu_options.c rk 07/15/16 Added support
for TapDelays at different frequencies. nsk 08/05/16 Added example support
PollData and PollTimeout Added XQSPIPSU_MSG_FLAG_POLL macro in xqspipsu.h Added
XQspiPsu_Create_PollConfigData and XQspiPsu_PollData() functions in xqspipsu.c
1.3 nsk 09/16/16 Update PollData and Polltimeout support for dual parallel
configuration. Updated XQspiPsu_PollData() and XQspiPsu_Create_PollConfigData()
functions in xqspipsu.c and also modified the polldata example ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. ms 04/05/17 Modified
Comment lines in functions of qspipsu examples to recognize it as documentation
block and modified filename tag to include them in doxygen examples. 1.4 tjs
05/26/17 Added support for accessing upper DDR (0x800000000) while booting
images from QSPI 1.5 tjs 08/08/17 Added index.html file for importing examples
from system.mss 1.5 nsk 08/14/17 Added CCI support 1.5 tjs 09/14/17 Modified the
checks for 4 byte addressing and commands. 1.6 tjs 10/16/17 Flow for accessing
flash is made similar to u-boot and linux For CR-984966 1.6 tjs 11/02/17
Resolved the compilation errors for ICCARM. CR-988625 1.7 tjs 11/16/17 Removed
the unsupported 4 Byte write and sector erase commands. 1.7 tjs 12/01/17 Added
support for MT25QL02G Flash from Micron. CR-990642 1.7 tjs 12/19/17 Added
support for S25FL064L from Spansion. CR-990724 1.7 tjs 01/11/18 Added support
for MX66L1G45G flash from Macronix CR-992367 1.7 tjs 01/16/18 Removed the check
for DMA MSB to be written. (CR992560) 1.7 tjs 01/17/18 Added support to toggle
the WP pin of flash. (PR2448) Added XQspiPsu_SetWP() in xqspipsu_options.c Added
XQspiPsu_WriteProtectToggle() in xqspipsu.c and also added write protect
example. 1.7 tjs 03/14/18 Added support in EL1 NS mode (CR974882) 1.7 tjs
26/03/18 In dual parallel mode enable both CS when issuing Write enable command.
CR-998478 1.8 tjs 05/02/18 Added support for IS25LP064 and IS25WP064. 1.8 tjs
06/26/18 Added an example for accessing 64bit dma within 32 bit application.
CR1004701 1.8 tjs 06/26/18 Removed checkpatch warnings 1.8 tjs 07/09/19 Fixed
cppcheck, doxygen and gcc warnings. 1.8 tjs 07/18/18 Setup64BRxDma() should be
called only if the RxAddress is greater than 32 bit address space. (CR1006862)
1.8 tjs 07/18/18 Added support for the low density ISSI flash parts. 1.8 tjs
09/06/18 Fixed the code in XQspiPsu_GenFifoEntryData() for data transfer length
up to 255 for reducing the extra loop. 1.9 tjs 11/22/17 Added the check for A72
and R5 processors (CR-987075) 1.9 tjs 04/17/18 Updated register addresses as per
the latest revision of versal (CR999610) 1.9 aru 01/17/19 Fixed the violations
for MISRAC-2012 in safety mode .Done changes such as added U suffix, Declared
pointer param as const. 1.9 nsk 02/01/19 Clear DMA_DST_ADDR_MSB register on
32bit machine, if the address is of only 32bit (CR1020031) 1.9 nsk 02/01/19
Added QSPI idling support 1.9 akm 03/08/19 Set recommended clock and data tap
delay values for 40MHZ, 100MHZ and 150MHZ frequencies(CR1023187) 1.9 nsk
03/27/19 Update 64bit dma support (CR1018102). 1.9 akm 04/03/19 Fixed data
alignment warnings on IAR compiler. 1.9 akm 04/03/19 Fixed compilation error in
XQspiPsu_LqspiRead() function on IAR compiler. </pre> /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/src/xqspipsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspipsu_g.c @addtogroup
qspipsu_v1_9 @{ This file contains a configuration table that specifies the
configuration of QSPIPSU devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.0 hk 08/21/14 First release sk 04/24/15
Modified the code according to MISRAC-2012. 1.8 tjs 07/09/18 Fixed gcc warnings.
(CR1006336). </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/src/xqspipsu_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspipsu_hw.h @addtogroup
qspipsu_v1_9 @{ This file contains low level access functions using the base
address directly without an instance. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- -----------------------------------------------. 1.0
hk 08/21/14 First release hk 03/18/15 Add DMA status register masks required. sk
04/24/15 Modified the code according to MISRAC-2012. 1.2 nsk 07/01/16 Added
LQSPI supported Masks rk 07/15/16 Added support for TapDelays at different
frequencies. 1.7 tjs 03/14/18 Added support in EL1 NS mode. 1.9 tjs 04/17/18
Updated register addresses as per the latest revision of versal (CR999610) 1.9
aru 01/17/19 Fixed the violations for MISRAC-2012 in safety mode .Done changes
such as added U suffix </pre>

FILES:
XilinxProcessorIPLib/drivers/qspipsu/src/xqspipsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspipsu_options.c @addtogroup
qspipsu_v1_9 @{ This file implements functions to configure the QSPIPSU
component, specifically some optional settings, clock and flash related
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.0 hk 08/21/14 First release sk 03/13/15 Added IO mode support. sk 04/24/15
Modified the code according to MISRAC-2012. 1.1 sk 04/12/16 Added debug message
prints. 1.2 nsk 07/01/16 Modified XQspiPsu_SetOptions() to support LQSPI options
and updated OptionsTable rk 07/15/16 Added support for TapDelays at different
frequencies. 1.7 tjs 01/17/18 Added support to toggle the WP pin of flash.
(PR2448) 1.7 tjs 03/14/18 Added support in EL1 NS mode. (CR974882) 1.8 tjs
05/02/18 Added support for IS25LP064 and IS25WP064. 1.8 tjs 07/26/18 Resolved
cppcheck errors. (CR1006336) 1.9 tjs 04/17/18 Updated register addresses as per
the latest revision of versal (CR999610) 1.9 aru 01/17/19 Fixes violations
according to MISRAC-2012 in safety mode and modified the code such as Added
Xil_MemCpy inplace of memcpy,Declared the pointer param as Pointer to const,
declared XQspi_Set_TapDelay() as static. 1.9 akm 03/08/19 Set recommended clock
and data tap delay values for 40MHZ, 100MHZ and 150MHZ frequencies(CR1023187)
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/src/xqspipsu_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xqspipsu_sinit.c @addtogroup
qspipsu_v1_9 @{ The implementation of the XQspiPsu component's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.0 hk 08/21/14 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/qspipsu/src/xqspipsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 cjp 09/05/17 First commit 1.1 Nava 04/20/18
Fixed compilation warnings. 1.2 cjp 04/27/18 Updated for clockps interdependency
uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/resetps/data/resetps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xresetps_example.c This file
contains a design example using the Reset Controller (ResetPs) driver. A list of
peripheral blocks to be reset is maintained. The list has a peripheral reset ID,
a register address that is to be modified, value to be modified and value after
reset for that register. The register provided for a peripheral block is
modified with the value provided. The peripheral is then reset and the register
value is cerified with reset value. @note <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 cjp 10/07/17 First release 1.2 cjp
04/27/18 Updated for clockps interdependency mus 02/28/19 Initialized FailCnt
variable </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/resetps/examples/xresetps_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xresetps.c @addtogroup
xresetps_v1_2 @{ Contains the implementation of interface functions of the
XResetPs driver. See xresetps.h for a description of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 cjp
09/05/17 First release 1.1 Nava 04/20/18 Fixed compilation warnings. 1.2 cjp
04/27/18 Updated for clockps interdependency 1.2 Nava 05/21/18 Fixed compilation
warnings on R5. 1.2 sd 07/20/18 Fixed Doxygen Reported warnings. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/resetps/src/xresetps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xresetps.h @addtogroup
xresetps_v1_2 @{ @details The Xilinx Reset Controller driver supports the
following features: - Assert reset for specific peripheral. - Deassert reset for
specific peripheral. - Pulse reset for specific peripheral. - Get reset status
for specific peripheral. This driver is intended to be RTOS and processor
independent. It works with physical addresses only. Any needs for dynamic memory
management, threads or thread mutual exclusion, virtual memory, or cache control
must be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 cjp 09/05/17 First release 1.1
Nava 04/20/18 Fixed compilation warnings. 1.2 cjp 04/27/18 Updated for clockps
interdependency 1.2 sd 07/20/18 Fixed Doxygen Reported warnings. </pre>

FILES:
XilinxProcessorIPLib/drivers/resetps/src/xresetps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xresetps_g.c @addtogroup
xresetps_v1_2 @{ This file contains a table that specifies the configuration of
the reset controller devices in the system. Each device should have an entry in
the table. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 cjp 09/05/17 First release 1.2 cjp 04/27/18 Updated for clockps
interdependency 1.2 sd 07/20/18 Fixed Doxygen warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/resetps/src/xresetps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xresetps_hw.h @addtogroup
xresetps_v1_2 @{ This file contains the hardware interface to the System Reset
controller. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 cjp 09/05/17 First release 1.1 Nava 04/20/18 Fixed compilation
warnings. 1.2 cjp 04/27/18 Updated for clockps interdependency </pre>

FILES:
XilinxProcessorIPLib/drivers/resetps/src/xresetps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xresetps_sinit.c @addtogroup
xresetps_v1_2 @{ This file contains method for static initialization (compile-
time) of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 cjp 09/05/17 First release 1.1 Nava 04/20/18 Fixed
compilation warnings. 1.2 cjp 04/27/18 Updated for clockps interdependency
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/resetps/src/xresetps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 sk 05/16/17 First releasae 2.1 sk 09/21/17
Add APP_COMPILER_FLAGS Option

FILES:
XilinxProcessorIPLib/drivers/rfdc/data/rfdc.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_clk.c This file contains
a programming example for using the lmx2594 and lmk04028 clock generator. This
example configures the lmx2594 to 20 frequencies. If 0 is passed then the chip
is powered down. For zcu111 board users are expected to define XPS_BOARD_ZCU111
macro while compiling this example. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.0 sd 04/11/18 First release 4.0 sd 05/22/18
Updated lmx configuration 5.0 sd 09/05/18 Updated lmx reset sequence </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/examples/xrfdc_clk.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_intr_example.c For the
RFSoC Data Converter, the interrupts are mostly used for error reporting. The
interrupts do not do any data processing. Since they dont do any data
processing, interrupts are invoked in rare conditions. The example here attempts
to demonstrate users how an error interrupt can be generated. Also once
generated how does the processing happen. Upon an interrupt, the control reaches
to ScuGIC interrupt handler. From there the control is transferred to the
libmetal isr handling which then calls the driver interrupt handler. Users are
expected to register their callbacks with the driver interrupt framework. The
actual interrupt handling is expected to happen in the user provided callback.
This example generates ADC fabric interrupts by writing some incorrect fabric
data rate based on the read/write clocks. For zcu111 board users are expected to
define XPS_BOARD_ZCU111 macro while compiling this example. This example is
design specific, PL-PS Interrupts must be attached and The Stimulus/Capture
Block device names/addresses may vary. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.0 sk 05/25/17 First release 1.1 sk 08/09/17
Modified the example to support both Linux and Baremetal. 2.2 sk 10/18/17 Check
for FIFO intr to return success. 4.0 sd 04/28/18 Add Clock configuration support
for ZCU111. sd 05/15/18 Updated Clock configuration for lmk. 5.0 sk 08/03/18 For
baremetal, add metal device structure for rfdc device and register the device to
libmetal generic bus. mus 08/18/18 Updated to remove xparameters.h dependency
for linux platform. 6.0 cog 02/06/19 Updated for libmetal v2.0 and added
configure PLL to set clock to incompatible rate cog 06/08/19 Linux platform
compatibility fixes. 7.0 cog 07/25/19 Updated example for new metal register
API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/examples/xrfdc_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_mts_example.c RFSoC
MultiTile Sync Example test application This example calls the RFdc Multi-tile-
sync (MTS) API with the following configuration: Tiles to Sync: DAC0, DAC1,
ADC0, ADC1, ADC2, ADC3. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
----- -------- 3.1 jm 01/24/18 First release 5.0 sk 09/05/18 Rename
XRFdc_MTS_RMW_DRP as XRFdc_ClrSetReg. 5 0 mus 08/18/18 Updated to remove
xparameters.h dependency for linux platform. 6.0 cog 02/21/19 Removed
unnecessary register writes. 02/21/19 Set frequency and sample rate to
appropriate values for MTS. 02/21/19 Set metal log level to DEBUG. 7.0 cog
07/25/19 Updated example for new metal register API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/examples/xrfdc_mts_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_read_write_example.c This
example uses multiple driver "set" APIs to configure the targeted AMS block.
Subsequently it uses "get" APIs to read back the configurations to ensure that
the desired configurations are applied. For DAC it sets the following
configurations: MixerSettings, QMCSettings, Write Fabricrate, Decoder mode,
Output Current and Coarse Delay. For ADC it sets the following configurations:
MixerSettings, QMCSettings, Read Fabricrate and Threshold Settings. This example
shows how to change the configurations for ADC and DAC using driver functions.
NOTE: The purpose of the example is to show how to use the driver APIs. For real
user scenarios this example will not be relevant. For zcu111 board users are
expected to define XPS_BOARD_ZCU111 macro while compiling this example. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 sk 05/15/17
First release 1.1 sk 08/09/17 Modified the example to support both Linux and
Baremetal. sk 08/23/17 Add Nyquist Zone test case. sk 09/25/17 Add GetOutput
Current test case. 2.4 sk 12/11/17 Add test case for DDC and DUC. 3.2 sk
03/01/18 Add test case for Multiband. 4.0 sd 04/28/18 Add Clock configuration
support for ZCU111. sd 05/15/18 Updated Clock configuration for lmk. 5.0 sk
07/20/18 Update mixer settings test cases to consider MixerType. sk 08/03/18 For
baremetal, add metal device structure for rfdc device and register the device to
libmetal generic bus. mus 08/18/18 Updated to remove xparameters.h dependency
for linux platform. sk 09/07/18 Modified phasecorrection factor as per QMC Phase
correction factor range in driver 5.1 cog 01/29/19 Fixed some comments. 7.0 cog
07/25/19 Updated example for new metal register API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/examples/xrfdc_read_write_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_selftest_example.c This
file contains a selftest example for using the rfdc hardware and RFSoC Data
Converter driver. This example does some writes to the hardware to do some
sanity checks and does a reset to restore the original settings. For zcu111
board users are expected to define XPS_BOARD_ZCU111 macro while compiling this
example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- --------
1.0 sk 05/25/17 First release 1.1 sk 08/09/17 Modified the example to support
both Linux and Baremetal. 4.0 sd 04/28/18 Add Clock configuration support for
ZCU111. sd 05/15/18 Updated Clock configuration for lmk. 5.0 sk 08/03/18 For
baremetal, add metal device structure for rfdc device and register the device to
libmetal generic bus. mus 08/18/18 Updated to remove xparameters.h dependency
for linux platform. 7.0 cog 07/25/19 Updated example for new metal register API.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/examples/xrfdc_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc.c @addtogroup xrfdc_v7_0
@{ Contains the interface functions of the XRFdc driver. See xrfdc.h for a
detailed description of the device and driver. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.0 sk 05/16/17 Initial release 2.0 sk
08/09/17 Fixed coarse Mixer configuration settings CR 977266, 977872. Return
error for Slice Event on 4G ADC Block. 08/16/17 Add support for SYSREF and PL
event sources. 08/18/17 Add API to enable and disable FIFO. 08/23/17 Add API to
configure Nyquist zone. 08/30/17 Add additional info to BlockStatus. 08/30/17
Add support for Coarse Mixer BYPASS mode. 08/31/17 Removed Tile Reset Assert and
Deassert. 09/07/17 Add support for negative NCO freq. 09/15/17 Fixed NCO freq
precision issue. 09/15/17 Fixed Immediate Event source issue and also updated
the Immediate Macro value to 0. 2.1 sk 09/15/17 Remove Libmetal library
dependency for MB. sk 09/25/17 Modified XRFdc_GetBlockStatus API to give correct
information and also updates the description for Vector Param in intr handler
Add API to get Output current and removed GetTermVoltage and GetOutputCurr
inline functions. 2.2 sk 10/05/17 Fixed XRFdc_GetNoOfADCBlocks API for 4GSPS.
Enable the decoder clock based on decoder mode. Add API to get the current FIFO
status. Updated XRFdc_DumpRegs API for better readability of output register
dump. Add support for 4GSPS CoarseMixer frequency. 10/11/17 Modify float types
to double to increase precision. 10/12/17 Update BlockStatus API to give current
status. In BYPASS mode, input datatype can be Real or IQ, hence checked both
while reading the mixer mode. 10/17/17 Fixed Set Threshold API Issue. 2.3 sk
11/06/17 Fixed PhaseOffset truncation issue. Provide user configurability for
FineMixerScale. 11/08/17 Return error for DAC R2C mode and ADC C2R mode.
11/20/17 Fixed StartUp, Shutdown and Reset API for Tile_Id -1. 11/20/17 Remove
unwanted ADC block checks in 4GSPS mode. 3.0 sk 12/11/17 Added DDC and DUC
support. 12/13/17 Add CoarseMixMode field in Mixer_Settings structure. 12/15/17
Add support to switch calibration modes. 12/15/17 Add support for mixer
frequencies > Fs/2 and < -Fs/2. sg 13/01/18 Added PLL and external clock switch
support. Added API to get PLL lock status. Added API to get clock source. 3.1 jm
01/24/18 Add Multi-tile sync support. sk 01/25/18 Updated Set and Get
Interpolation/Decimation factor API's to consider the actual factor value. 3.2
sk 02/02/18 Add API's to configure inverse-sinc. sk 02/27/18 Add API's to
configure Multiband. sk 03/09/18 Update PLL structure in XRFdc_DynamicPLLConfig
API. sk 03/09/18 Update ADC and DAC datatypes in Mixer API and use input
datatype for ADC in threshold and QMC APIs. sk 03/09/18 Removed FIFO disable
check in DDC and DUC APIs. sk 03/09/18 Add support for Marker event source for
DAC block. sk 03/22/18 Updated PLL settings based on latest IP values. 4.0 sk
04/17/18 Corrected Set/Get MixerSettings API description for FineMixerScale
parameter. sk 04/19/18 Enable VCO Auto selection while configuring the clock. sk
04/24/18 Add API to get PLL Configurations. sk 04/24/18 Add API to get the Link
Coupling mode. sk 04/28/18 Implement timeouts for PLL Lock, Startup and
shutdown. sk 05/30/18 Removed CalibrationMode check for DAC. sk 06/05/18 Updated
minimum Ref clock value to 102.40625MHz. 5.0 sk 06/25/18 Update DAC min sampling
rate to 500MHz and also update VCO Range, PLL_DIVIDER and PLL_FPDIV ranges. sk
06/25/18 Add XRFdc_GetFabClkOutDiv() API to read fabric clk div. Add Inline APIs
XRFdc_CheckBlockEnabled(), XRFdc_CheckTileEnabled(). sk 07/06/18 Add support to
dump HSCOM regs in XRFdc_DumpRegs() API sk 07/12/18 Fixed Multiband crossbar
settings in C2C mode. sk 07/19/18 Add MixerType member to MixerSettings
structure and Update Mixer Settings APIs to consider the MixerType variable. sk
07/19/18 Add XRFdc_GetMultibandConfig() API to read Multiband configuration. sk
07/20/18 Update the APIs to check the corresponding section
(Digital/Analog)enable/disable. sk 07/26/18 Fixed Doxygen, coverity warnings. sk
08/03/18 Fixed MISRAC warnings. sk 08/24/18 Move mixer related APIs to
xrfdc_mixer.c file. Define asserts for Linux, Re-arranged XRFdc_RestartIPSM,
XRFdc_CfgInitialize() and XRFdc_MultiBand() APIs. Reorganize the code to improve
readability and optimization. sk 09/24/18 Update powerup-state value based on
PLL mode in XRFdc_DynamicPLLConfig() API. sk 10/10/18 Check for DigitalPath
enable in XRFdc_GetNyquistZone() and XRFdc_GetCalibrationMode() APIs for
Multiband. sk 10/13/18 Add support to read the REFCLKDIV param from design.
Update XRFdc_SetPLLConfig() API to support range of REF_CLK_DIV values(1 to 4).
5.1 cog 01/29/19 Replace structure reference ADC checks with function. cog
01/29/19 Added XRFdc_SetDither() and XRFdc_GetDither() APIs. cog 01/29/19 Rename
DataType for mixer input to MixerInputDataType for readability. cog 01/29/19
Refactoring of interpolation and decimation APIs and changed fabric rate for
decimation X8 for non-high speed ADCs. cog 01/29/19 New inline functions to
determine max & min sampling rates rates in PLL range checking. 6.0 cog 02/17/19
Added decimation & interpolation modes 02/17/19 Added Inverse-Sinc Second
Nyquist Zone Support cog 02/17/19 Added new clock Distribution functionality.
cog 02/17/19 Refactored to improve delay balancing in clock distribution. cog
02/17/19 Added delay calculation & metal log messages. cog 02/17/19 Added
intratile clock settings. cog 02/17/19 Moved multiband to a new file xrfdc_mb.c
cog 02/17/19 Moved clocking functionality to a new file xrfdc_clock.c cog
02/17/19 Added XRFdc_SetIMRPassMode() and XRFdc_SetIMRPassMode() APIs cog
02/17/19 Added XRFdc_SetDACMode() and XRFdc_GetDACMode() APIs cog 02/17/19 Added
XRFdc_SetSignalDetector() and XRFdc_GetSignalDetector() APIs. cog 02/17/19 Added
XRFdc_DisableCoefficientsOverride(), XRFdc_SetCalCoefficients and
XRFdc_GetCalCoefficients APIs. cog 02/21/19 Added XRFdc_SetCalFreeze() and
XRFdc_GetCalFreeze() APIs. cog 04/09/19 Changed calibration coefficient override
control register for OCB1. cog 04/15/19 Rename XRFdc_SetDACMode() and
XRFdc_GetDACMode() APIs to XRFdc_SetDataPathMode() and XRFdc_GetDataPathMode()
respectively. cog 04/30/19 Made Changes to the bypass calibration functionality
to support Gen2 and below. 7.0 cog 05/13/19 Formatting changes. cog 07/16/19
Added XRFdc_SetDACOpCurr() API. cog 07/18/19 Added
XRFdc_S/GetDigitalStepAttenuator() APIs. cog 07/25/19 Baremetal Region mapping
now taken care of in XRFdc_RegisterMetal(). cog 07/25/19 Moved
XRFDC_PLL_LOCK_DLY_CNT macro to header file. cog 07/26/19 Added new
XRFdc_S/GetLegacyCompatibilityMode() APIs. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc.h @addtogroup rfdc_v7_0
@{ @details The Xilinx� LogiCORE IP Zynq UltraScale+ RFSoC RF Data Converter
IP core provides a configurable wrapper to allow the RF DAC and RF ADC blocks to
be used in IP Integrator designs. Multiple tiles are available on each RFSoC and
each tile can have a number of data converters (analog-to-digital (ADC) and
digital-to-analog (DAC)). The RF ADCs can sample input frequencies up to 4 GHz
at 4 GSPS with excellent noise spectral density. The RF DACs generate output
carrier frequencies up to 4 GHz using the 2nd Nyquist zone with excellent noise
spectral density at an update rate of 6.4 GSPS. The RF data converters also
include power efficient digital down-converters (DDCs) and digital up-converters
(DUCs) that include programmable interpolation and decimation, NCO and complex
mixer. The DDCs and DUCs can also support dual-band operation. A maximum of 4
tiles are available on for DAC and ADC operations each. Each tile can have a
maximum of 4 blocks/slices. This driver provides APIs to configure various
functionalities. Similarly the driver provides APIs to read back configurations.
Some of the features that the driver supports are: 1) Setting up and reading
back fine mixer settings 2) Setting up and reading back coarse mixer settings 3)
Reading back interpolation or decimation factors 4) Setting up and reading back
QMC settings which include gain, phase etc 5) Setting up and reading back
decoder mode settings 6) Setting up and reading back coarse delay settings All
the APIs implemented in the driver provide appropriate range checks. An API has
been provided for debug purpose which will dump all registers for a requested
tile. Inline functions have also been provided to read back the parameters
initially configured through the GUI. There are plans to add more features, e.g.
Support for multi band, PLL configurations etc. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.0 sk 05/16/17 Initial release 2.0 sk
08/09/17 Fixed coarse Mixer configuration settings CR 977266, 977872. Return
error for Slice Event on 4G ADC Block. Corrected Interrupt Macro names and
values. 08/16/17 Add support for SYSREF and PL event sources. 08/18/17 Add API
to enable and disable FIFO. 08/23/17 Add API to configure Nyquist zone. 08/30/17
Add additional info to BlockStatus. 08/30/17 Add support for Coarse Mixer BYPASS
mode. 08/31/17 Removed Tile Reset Assert and Deassert. 09/07/17 Add support for
negative NCO freq. 09/15/17 Fixed NCO freq precision issue. 09/15/17 Fixed
Immediate Event source issue and also updated the Immediate Macro value to 0.
2.1 sk 09/15/17 Remove Libmetal library dependency for MB. 09/18/17 Add API to
clear the interrupts. sk 09/21/17 Add __BAREMETAL__ compiler flag option for
Baremetal. sk 09/21/17 Add support for Over voltage and Over Range interrupts.
sk 09/22/17 Add s64 typedef for Linux. sk 09/24/17 Fixed Get_Tile/BlockBaseAddr
always giving ADC related address. sk 09/25/17 Modified XRFdc_GetBlockStatus API
to give correct information and also updates the description for Vector Param in
intr handler Add API to get Output current and removed GetTermVoltage and
GetOutputCurr inline functions. 2.2 sk 10/05/17 Fixed XRFdc_GetNoOfADCBlocks API
for 4GSPS. Enable the decoder clock based on decoder mode. Add API to get the
current FIFO status. Updated XRFdc_DumpRegs API for better readability of output
register dump. Add support for 4GSPS CoarseMixer frequency. 10/11/17 Modify
float types to double to increase precision. 10/12/17 Update BlockStatus API to
give current status. In BYPASS mode, input datatype can be Real or IQ hence
checked both while reading the mixer mode. 10/17/17 Fixed Set Threshold API
Issue. 2.2 sk 10/18/17 Add support for FIFO and DATA overflow interrupt 2.3 sk
11/06/17 Fixed PhaseOffset truncation issue. Provide user configurability for
FineMixerScale. 11/08/17 Return error for DAC R2C mode and ADC C2R mode.
11/10/17 Corrected FIFO and DATA Interrupt masks. 11/20/17 Fixed StartUp,
Shutdown and Reset API for Tile_Id -1. 11/20/17 Remove unwanted ADC block checks
in 4GSPS mode. 3.0 sk 12/11/17 Added DDC and DUC support. 12/13/17 Add
CoarseMixMode field in Mixer_Settings structure. 12/15/17 Add support to switch
calibration modes. 12/15/17 Add support for mixer frequencies > Fs/2 and <
-Fs/2. sg 13/01/18 Added PLL and external clock switch support Added API to get
PLL lock status. Added API to get clock source. sk 01/18/18 Add API to get
driver version. 3.1 jm 01/24/18 Add Multi-tile sync support. sk 01/25/18 Updated
Set and Get Interpolation/Decimation factor API's to consider the actual factor
value. 3.2 sk 02/02/18 Add API's to configure inverse-sinc. sk 02/27/18 Add
API's to configure Multiband. sk 03/09/18 Update PLL structure in
XRFdc_DynamicPLLConfig API. sk 03/09/18 Update ADC and DAC datatypes in Mixer
API and use input datatype for ADC in threshold and QMC APIs. sk 03/09/18
Removed FIFO disable check in DDC and DUC APIs. sk 03/09/18 Add support for
Marker event source for DAC block. jm 03/12/18 Fixed DAC latency calculation in
MTS. jm 03/12/18 Added support for reloading DTC scans. jm 03/12/18 Add option
to configure sysref capture after MTS. sk 03/22/18 Updated PLL settings based on
latest IP values. 4.0 sk 04/09/18 Added API to enable/disable the sysref. sk
04/09/18 Updated max VCO to 13108MHz to support max DAC sample rate of 6.554MHz.
rk 04/17/18 Adjust calculated latency by sysref period, where doing so results
in closer alignment to the target latency. sk 04/17/18 Corrected Set/Get
MixerSettings API description for FineMixerScale parameter. sk 04/19/18 Enable
VCO Auto selection while configuring the clock. sk 04/24/18 Add API to get PLL
Configurations. sk 04/24/18 Add API to get the Link Coupling mode. sk 04/28/18
Implement timeouts for PLL Lock, Startup and shutdown. sk 05/30/18 Removed
CalibrationMode check for DAC. sk 06/05/18 Updated minimum Ref clock value to
102.40625MHz. 5.0 sk 06/25/18 Update DAC min sampling rate to 500MHz and also
update VCO Range, PLL_DIVIDER and PLL_FPDIV ranges. Update PLL structure with
calculated sampling rate. sk 06/25/18 Add XRFdc_GetFabClkOutDiv() API to read
fabric clk div. Add Inline APIs XRFdc_CheckBlockEnabled(),
XRFdc_CheckTileEnabled(). sk 07/06/18 Add support to dump HSCOM regs in
XRFdc_DumpRegs() API sk 07/12/18 Fixed Multiband crossbar settings in C2C mode.
sk 07/19/18 Add MixerType member to MixerSettings structure and Update Mixer
Settings APIs to consider the MixerType variable. sk 07/19/18 Add
XRFdc_GetMultibandConfig() API to read Multiband configuration. sk 07/20/18
Update the APIs to check the corresponding section
(Digital/Analog)enable/disable. sk 07/26/18 Fixed Doxygen, coverity warnings. sk
08/03/18 Fixed MISRAC warnings. sk 08/24/18 Move mixer related APIs to
xrfdc_mixer.c file. Define asserts for Linux, Re-arranged XRFdc_RestartIPSM,
XRFdc_CfgInitialize() and XRFdc_MultiBand() APIs. Reorganize the code to improve
readability and optimization. mus 08/17/18 Removed structure paddings from
XRFdc_Config structure. It has been done to have 1:1 mapping between
XRFdc_Config structure and device tree property "param-list", over linux
platform. sk 09/24/18 Update powerup-state value based on PLL mode in
XRFdc_DynamicPLLConfig() API. sk 10/10/18 Check for DigitalPath enable in
XRFdc_GetNyquistZone() and XRFdc_GetCalibrationMode() APIs for Multiband. sk
10/13/18 Add support to read the REFCLKDIV param from design. Update
XRFdc_SetPLLConfig() API to support range of REF_CLK_DIV values(1 to 4). Add
XRFDC_MIXER_MODE_R2R option to support BYPASS mode for Real input. 5.1 cog
01/29/19 Replace structure reference ADC checks with function. cog 01/29/19
Added XRFdc_SetDither() and XRFdc_GetDither() APIs. cog 01/29/19 Rename DataType
for mixer input to MixerInputDataType for readability. cog 01/29/19 Refactoring
of interpolation and decimation APIs and changed fabric rate for decimation X8
for non-high speed ADCs. cog 01/29/19 New inline functions to determine max &
min sampling rates. 6.0 cog 02/17/19 Added Inverse-Sinc Second Nyquist Zone
Support cog 02/17/19 Added new clock Distribution functionality. cog 02/17/19
Refactored to improve delay balancing in clock distribution. cog 02/17/19 Added
delay calculation & metal log messages. cog 02/17/19 Added Intratile clock
settings. cog 02/17/19 XRFdc_GetPLLConfig() now uses register values to get the
PLL configuration for new IPs and is no longer static. cog 02/17/19 Refactoring
of interpolation and decimation APIs and changed fabric rate for decimation X8
for non-high speed ADCs. cog 02/17/19 Added XRFdc_SetIMRPassMode() and
XRFdc_SetIMRPassMode() APIs cog 02/17/19 Added XRFdc_SetDACMode() and
XRFdc_GetDACMode() APIs cog 02/17/19 Added XRFdc_SetSignalDetector() and
XRFdc_GetSignalDetector() APIs cog 02/17/19 Added
XRFdc_DisableCoefficientsOverride(), XRFdc_SetCalCoefficients and
XRFdc_GetCalCoefficients APIs. cog 02/19/19 New definitions for clock detection.
6.0 cog 02/20/19 Added handling for new ADC common mode over/under voltage
interrupts. cog 02/20/19 XRFdc_GetIntrStatus now populates a pointer with the
status and returns an error code. cog 02/20/19 XRFdc_IntrClr, XRFdc_IntrDisable
and XRFdc_IntrEnable now return error codes. cog 02/21/19 Added
XRFdc_SetCalFreeze() and XRFdc_GetCalFreeze() APIs cog 04/15/19 Rename
XRFdc_SetDACMode() and XRFdc_GetDACMode() APIs to XRFdc_SetDataPathMode() and
XRFdc_GetDataPathMode() respectively. 7.0 cog 05/13/19 Formatting changes. cog
05/13/19 Added new bock MACROs. cog 05/13/19 XRFdc_CheckTileEnabled(),
XRFdc_IsDACBlockEnabled(), XRFdc_IsADCBlockEnabled(),
XRFdc_IsDACDigitalPathEnabled() & XRFdc_IsADCDigitalPathEnabled() APIs now
derive answer from DRP rather than context structure. cog 06/12/19 Fixed issue
where positive NCO frequencies were not being set correctly. cog 07/14/19 Added
new off mode for mixers (both mixers off). cog 07/16/19 The powerup state is not
necessary to be checked for the tile/block/digital path enabled functions and
had potential to cause lockout. cog 07/16/19 Added XRFdc_SetDACOpCurr() API. cog
07/18/19 Added XRFdc_S/GetDigitalStepAttenuator() APIs. cog 07/25/19 Added new
XRFdc_RegisterMetal() API to register RFDC with Libmetal. cog 07/25/19 Moved
XRFDC_PLL_LOCK_DLY_CNT macro from source file. cog 07/26/19 Added new
XRFdc_S/GetLegacyCompatibilityMode() APIs. cog 07/29/19 Added
XRFdc_GetEnabledInterrupts() API. </pre>

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_clock.c @addtogroup
xrfdc_v7_0 @{ Contains the interface functions of the Mixer Settings in XRFdc
driver. See xrfdc.h for a detailed description of the device and driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 6.0 cog 02/17/19
Initial release. cog 03/12/19 Invert clock detection bits to support IP change.
cog 03/12/19 Fix bug where incorrect FS, RefClk and were output divider were
being returned. cog 04/09/19 Discriminate between Gen 3 IP and lower for
checking if internal PLL is enabled. cog 04/09/19 Fixed issue where tile was not
autostarting after PLL rate change. 7.0 cog 05/13/19 Formatting changes. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_clock.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_g.c @addtogroup rfdc_v7_0
@{ This file contains a configuration table that specifies the configuration of
RFdc devices in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.0 sk 05/16/17 Initial release 5.1 cog 01/29/19 Added FSMax,
NumSlice & IP_Type. 7.0 cog 05/13/19 Formatting changes. </pre>

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_hw.h @addtogroup
rfdc_v7_0 @{ This header file contains the identifiers and basic HW access
driver functions (or macros) that can be used to access the device. Other driver
functions are defined in xrfdc.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.0 sk 05/16/17 Initial release 2.1 sk 09/15/17
Remove Libmetal library dependency for MB. sk 09/21/17 Add support for Over
voltage and Over Range interrupts. 2.3 sk 11/10/17 Corrected FIFO and DATA
Interrupt masks. 2.4 sk 12/11/17 Added DDC and DUC support. 3.0 sg 13/01/18
Added PLL and external clock switch support 3.1 jm 01/24/18 Add Multi-tile sync
support. sk 02/27/18 Add API's to configure Multiband. 4.0 sk 04/09/18 Removed
redundant inclusion of xparameters.h file. 5.0 sk 08/03/18 Fixed MISRAC
warnings. sk 08/24/18 Reorganize the code to improve readability and
optimization. 5.1 cog 01/29/19 Added XRFdc_SetDither() and XRFdc_GetDither()
APIs. 6.0 cog 02/17/19 New Interp/Decimation Mask. cog 02/17/19 Added new
Inverse-Sinc mask. cog 02/17/19 Added new clock Distribution Defs. cog 02/17/19
Added new intratile clock Defs. cog 02/17/19 New Masks and offsets for
XRFdc_GetPLLConfig() API. cog 02/17/19 New Masks and offsets for
XRFdc_SetIMRPassMode() and XRFdc_SetIMRPassMode() APIs cog 02/17/19 New Masks
and offsets for XRFdc_SetDACMode() and XRFdc_GetDACMode() APIs cog 02/17/19 New
Masks and offsets for XRFdc_SetSignalDetector() and XRFdc_GetSignalDetector()
APIs. cog 02/17/19 New Masks and offsets for
XRFdc_DisableCoefficientsOverride(), XRFdc_SetCalCoefficients and
XRFdc_GetCalCoefficients APIs. cog 02/19/19 New Masks and offsets for clock
detection register. cog 02/20/19 New Masks for ADC common mode over/under
voltage interrupts. cog 02/21/19 New Masks and offsets for XRFdc_SetCalFreeze()
and XRFdc_GetCalFreeze() APIs. cog 03/25/19 The new common mode over/under
voltage interrupts mask bits were clashing with other interrupt bits. cog
03/25/19 Added more calibration bypass masks. 7.0 cog 05/13/19 Formatting
changes. cog 05/13/19 Added common power up interrupt masks/shifts. cog 07/16/19
Added XRFdc_SetDACOpCurr() API masks/shifts. cog 07/18/19 Added
XRFdc_S/GetDigitalStepAttenuator() API masks/shifts. cog 07/26/19 Added
XRFdc_S/GetLegacyCompatibilityMode() API shift. </pre>

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_intr.c @addtogroup
rfdc_v7_0 @{ This file contains functions related to RFdc interrupt handling.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 sk
05/16/17 First release 2.1 sk 09/15/17 Remove Libmetal library dependency for
MB. 09/18/17 Add API to clear the interrupts. sk 09/21/17 Add support for Over
voltage and Over Range interrupts. 2.2 sk 10/18/17 Add support for FIFO and DATA
overflow interrupt 5.0 sk 08/24/18 Reorganize the code to improve readability
and optimization. 5.1 cog 01/29/19 Replace structure reference ADC checks with
function. 6.0 cog 02/20/19 Added handling for new ADC common mode over/under
voltage interrupts. cog 02/20/19 XRFdc_GetIntrStatus now populates a pointer
with the status and returns an error code. cog 02/20/19 XRFdc_IntrClr,
XRFdc_IntrDisable and XRFdc_IntrEnable now return error codes. cog 03/25/19 The
new common mode over/under voltage interrupts mask bits were clashing with other
interrupt bits. 7.0 cog 05/13/19 Formatting changes. cog 05/13/19 Re-factor of
interrupt clear/status handling. cog 05/13/19 Added handling for common power up
interrupt. cog 07/29/19 Added XRFdc_GetEnabledInterrupts() API. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_mb.c @addtogroup
xrfdc_v7_0 @{ Contains the interface functions of the Mixer Settings in XRFdc
driver. See xrfdc.h for a detailed description of the device and driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 6.0 cog 02/17/18
Initial release/handle alternate bound out. 7.0 cog 05/13/19 Formatting changes.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_mb.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_mixer.c @addtogroup
xrfdc_v7_0 @{ Contains the interface functions of the Mixer Settings in XRFdc
driver. See xrfdc.h for a detailed description of the device and driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 5.0 sk 08/06/18
Initial release 5.1 cog 01/29/19 Replace structure reference ADC checks with
function. cog 01/29/19 XRFdc_SetCoarseMixer and MixerRangeCheck now need Tile_id
as a parameter. cog 01/29/19 Rename DataType to MixerInputDataType for
readability. 7.0 cog 05/13/19 Formatting changes. cog 06/12/19 Fixed issue where
positive NCO frequencies were not being set correctly. cog 07/03/19 Added new
off mode for mixers (both mixers off). </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_mixer.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_mts.c @addtogroup
xrfdc_v7_0 @{ Contains the multi tile sync functions of the XRFdc driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 3.1 jm 01/24/18
Initial release 3.2 jm 03/12/18 Fixed DAC latency calculation. jm 03/12/18 Added
support for reloading DTC scans. jm 03/12/18 Add option to configure sysref
capture after MTS. 4.0 sk 04/09/18 Added API to enable/disable the sysref. rk
04/17/18 Adjust calculated latency by sysref period, where doing so results in
closer alignment to the target latency. 5.0 sk 08/03/18 Fixed MISRAC warnings.
sk 08/03/18 Check for Block0 enable for tiles participating in MTS. sk 08/24/18
Reorganize the code to improve readability and optimization. 5.1 cog 01/29/19
Replace structure reference ADC checks with function. 6.0 cog 02/17/19 Added
XRFdc_GetMTSEnable API. 7.0 cog 05/13/19 Formatting changes. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_mts.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_mts.c @addtogroup
xrfdc_v7_0 @{ Contains the multi tile sync related structures, Macros of the
XRFdc driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 3.1 jm 01/24/18 Initial release 3.2 jm 03/12/18 Fixed DAC latency
calculation. jm 03/12/18 Added support for reloading DTC scans. jm 03/12/18 Add
option to configure sysref capture after MTS. 4.0 sk 04/09/18 Added API to
enable/disable the sysref. rk 04/17/18 Adjust calculated latency by sysref
period, where doing so results in closer alignment to the target latency. 5.0 sk
08/03/18 Fixed MISRAC warnings. sk 08/03/18 Check for Block0 enable for tiles
participating in MTS. sk 08/24/18 Reorganize the code to improve readability and
optimization. 6.0 cog 02/17/19 Added XRFdc_GetMTSEnable API. 7.0 cog 05/13/19
Formatting changes. </pre>

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_mts.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrfdc_sinit.c @addtogroup
rfdc_v7_0 @{ The implementation of the XRFdc component's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.0 sk 05/16/17 Initial release 5.0 mus 08/17/18 Updated
XRFdc_LookupConfig to make use of device tree instead of xrfdc_g.c, to obtain
XRFdc_Config for provided device id.It is being achieved through "param-list"
property in RFDC device node, it will be having 1:1 mapping with the
XRFdc_Config structure. Said changes have been done, to remove the xparameters.h
dependency from RFDC Linux user space driver. 7.0 cog 05/13/19 Formatting
changes. cog 07/25/19 Added new XRFdc_RegisterMetal() API to register RFDC with
Libmetal </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rfdc/src/xrfdc_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- ----------- 7.0 adk 01/28/14 FirstRelease 7.1 ms 01/16/17
Updated the parameter naming from XPAR_RGB2YCRCB_NUM_INSTANCES to
XPAR_XRGB2YCRCB_NUM_INSTANCES to avoid compilation failure for
XPAR_RGB2YCRCB_NUM_INSTANCES as the tools are generating
XPAR_XRGB2YCRCB_NUM_INSTANCES in the generated xrgb2ycrcb_g.c for fixing MISRA-C
files. This is a fix for CR-966099 based on the update in the tools.

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/data/rgb2ycrcb.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rgb2ycrcb_example.c This file
demonstrates how to use Xilinx RGB to YCrCb Color Space Converter (RGB2YCRCB)
driver on Xilinx RGB to YCrCb Color Space Converter (RGB2YCRCB) core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 7.00 adk 07/07/14
First release. </pre>

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/examples/rgb2ycrcb_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rgb2ycrcb_selftest_example.c
This file contains an example using the XRgb2YCrCb driver to do self test on the
device. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 7.0 adk 01/20/14 First Release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/examples/rgb2ycrcb_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrgb2ycrcb.c @addtogroup
rgb2ycrcb_v7_1 @{ This file contains the implementation of the interface
functions for RGB2YCRCB driver. Refer to the header file xrgb2ycrcb.h for more
detailed information. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 5.00a tb 02/27/12 Updated for RGB2YCRCB v5.00.a. 7.0 adk
01/07/14 Changed the file name from "rgb2ycrcb.c" to "xrgb2ycrcb.c". Implemented
the following functions: XRgb2YCrCb_CfgInitialize, XRgb2YCrCb_EnableDbgByPass,
XRgb2YCrCb_IsDbgByPassEnabled, XRgb2YCrCb_DisableDbgBypass,
XRgb2YCrCb_EnableDbgTestPattern, XRgb2YCrCb_IsDbgTestPatternEnabled,
XRgb2YCrCb_DisableDbgTestPattern, XRgb2YCrCb_GetVersion,
XRgb2YCrCb_GetDbgFrameCount, XRgb2YCrCb_GetDbgLineCount,
XRgb2YCrCb_GetDbgPixelCount, XRgb2YCrCb_Setup, XRgb2YCrCb_SetActiveSize,
XRgb2YCrCb_GetActiveSize, XRgb2YCrCb_SetYMax, XRgb2YCrCb_GetYMax,
XRgb2YCrCb_SetYMin, XRgb2YCrCb_GetYMin, XRgb2YCrCb_SetCbMax,
XRgb2YCrCb_GetCbMax, XRgb2YCrCb_SetCbMin, XRgb2YCrCb_GetCbMin,
XRgb2YCrCb_SetCrMax, XRgb2YCrCb_GetCrMax, XRgb2YCrCb_SetCrMin,
XRgb2YCrCb_GetCrMin, XRgb2YCrCb_SetYOffset, XRgb2YCrCb_GetYOffset,
XRgb2YCrCb_SetCbOffset, XRgb2YCrCb_GetCbOffset, XRgb2YCrCb_SetCrOffset,
XRgb2YCrCb_GetCrOffset, XRgb2YCrCb_SetCoefs, XRgb2YCrCb_GetCoefs,
XRgb2YCrCb_Select_Standard, XRgb2YCrCb_Coefficient_Translation,
XRgb2YCrCb_Select_OutputRange. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/src/xrgb2ycrcb.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrgb2ycrcb.h @addtogroup
rgb2ycrcb_v7_1 @{ @details This header file contains identifiers and register-
level driver functions (or macros), range macros, structure typedefs that can be
used to access the Xilinx Rgb2YCrCb core instance. The RGB to YCrCb Color-Space
Convertor core is a simplified 3x3 matrix multiplier converts three input color
samples to three output samples in a single clock cycle. The core supports four
common format conversions as well as a custom mode that allows for a user-
defined transform. The core is capable of a maximum resolution of 7680 columns
by 7680 rows with 8, 10, 12, or 16 bits per pixel. <b>Initialization &
Configuration</b> The device driver enables higher layer software (e.g., an
application) to communicate to the RGB2YCRCB core. XRgb2YCrCb_CfgInitialize()
API is used to initialize the RGB2YCRCB core. The user needs to first call the
XRgb2YCrCb_LookupConfig() API which returns the Configuration structure pointer
which is passed as a parameter to the XRgb2YCrCb_CfgInitialize() API. <b>
Interrupts </b> The driver provides an interrupt handler XRgb2YCrCb_IntrHandler
for handling the interrupt from the RGB2YCRCB core. The users of this driver
have to register this handler with the interrupt system and provide the callback
functions by using XRgb2YCrCb_SetCallBack API. <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b> Building the driver </b> The XRgb2YCrCb
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 5.00a tb 02/27/12 Updated
for RGB2YCRCB V5.00.a 5.01a bao 12/28/12 Converted from xio.h to xil_io.h,
translating basic types, MB cache functions, exceptions and assertions to xil_io
format. 6.0 adk 19/12/13 Updated as per the New Tcl API's. 7.0 adk 01/07/14
Changed the file name from "rgb2ycrcb.h" to "xrgb2ycrcb.h". Moved register
offsets and bit definitions from rgb2ycrcb.h file to xrgb2ycrcb_hw.h file.
Removed RGB_TIMING_STATUS register offset because this register is not present
in latest product guide. Removed following function macros: RGB_Enable,
RGB_Disable, RGB_RegUpdateEnable, RGB_RegUpdateDisable, RGB_Reset,
RGB_ClearReset, RGB_AutoSyncReset. Removed following functions:
RGB_select_standard, RGB_coefficient_translation, RGB_set_coefficients,
RGB_get_coefficients. Added following handler types as enum:
XRGB_HANDLER_PROCSTART, XRGB_HANDLER_FRAMEDONE, XRGB_HANDLER_ERROR. Added
following standard types as enum: XRGB_STANDARD_ITU_601_SD,
XRGB_STANDARD_ITU_709_NTSC, XRGB_STANDARD_ITU_709_PAL, XRGB_STANDARD_YUV,
XRGB_STANDARD_CUSTOM. Added following output ranges as enum: XRGB_TV_16_TO_240,
XRGB_STUDIO_16_TO_235, XRGB_GRAPHICS_0_TO_255. Added range macros for
ActiveSize, YMAX, YMIN, YOFFSET, CBMAX, CBMIN, CBOFFSET, CRMAX, CRMIN, CROFFSET
registers. Added following function macros: XRgb2YCrCb_IntrEnable,
XRgb2YCrCb_SyncReset, XRgb2YCrCb_IntrDisable, XRgb2YCrCb_StatusGetPending,
XRgb2YCrCb_IntrGetPending, XRgb2YCrCb_IntrClear, XRgb2YCrCb_RegUpdateEnable,
XRgb2YCrCb_RegUpdateDisable, XRgb2YCrCb_Reset, XRgb2YCrCb_Enable,
XRgb2YCrCb_Disable, XRgb2YCrCb_Start, XRgb2YCrCb_Stop. Added core and
configuration structure. Renamed rgb_coef_inputs -> XRgb2YCrCb_Coef_Inputs and
rgb_coef_outputs - > XRgb2YCrCb_Coef_Outputs. Added callback functions typedef.
Implemented XRgb2YCrCb_LookupConfig in xrgb2ycrcb_sinit.c Implemented
XRgb2YCrCb_SelfTest in xrgb2ycrcb_selftest.c Implemented XRgb2YCrCb_IntrHandler,
XRgb2YCrCb_SetCallBack in xrgb2ycrcb_intr.c. Implemented following functions in
xrgb2ycrcb.c: XRgb2YCrCb_CfgInitialize, XRgb2YCrCb_EnableDbgByPass,
XRgb2YCrCb_IsDbgByPassEnabled, XRgb2YCrCb_DisableDbgBypass,
XRgb2YCrCb_EnableDbgTestPattern, XRgb2YCrCb_IsDbgTestPatternEnabled,
XRgb2YCrCb_DisableDbgTestPattern, XRgb2YCrCb_GetVersion,
XRgb2YCrCb_GetDbgFrameCount, XRgb2YCrCb_GetDbgLineCount,
XRgb2YCrCb_GetDbgPixelCount, XRgb2YCrCb_Setup, XRgb2YCrCb_SetActiveSize,
XRgb2YCrCb_GetActiveSize, XRgb2YCrCb_SetYMax, XRgb2YCrCb_GetYMax,
XRgb2YCrCb_SetYMin, XRgb2YCrCb_GetYMin, XRgb2YCrCb_SetCbMax,
XRgb2YCrCb_GetCbMax, XRgb2YCrCb_SetCbMin, XRgb2YCrCb_GetCbMin,
XRgb2YCrCb_SetCrMax, XRgb2YCrCb_GetCrMax, XRgb2YCrCb_SetCrMin,
XRgb2YCrCb_GetCrMin, XRgb2YCrCb_SetYOffset, XRgb2YCrCb_GetYOffset,
XRgb2YCrCb_SetCbOffset, XRgb2YCrCb_GetCbOffset, XRgb2YCrCb_SetCrOffset,
XRgb2YCrCb_GetCrOffset, XRgb2YCrCb_SetCoefs, XRgb2YCrCb_GetCoefs,
XRgb2YCrCb_Select_Standard, XRgb2YCrCb_Coefficient_Translation,
XRgb2YCrCb_Select_OutputRange. 7.1 ms 01/16/17 Updated the parameter naming from
XPAR_RGB2YCRCB_NUM_INSTANCES to XPAR_XRGB2YCRCB_NUM_INSTANCES to avoid
compilation failure for XPAR_RGB2YCRCB_NUM_INSTANCES as the tools are generating
XPAR_XRGB2YCRCB_NUM_INSTANCES in the generated xrgb2ycrcb_g.c for fixing MISRA-C
files. This is a fix for CR-966099 based on the update in the tools. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/src/xrgb2ycrcb.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrgb2ycrcb_hw.h @addtogroup
rgb2ycrcb_v7_1 @{ This header file contains identifiers and register-level
driver functions (or macros) that can be used to access the Xilinx RGB to YCrCb
color space converter (RGB2YCRCB) core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 7.0 adk 01/28/14 First release. Added the register
offsets and bit masks for the registers. Added backward compatibility macros.
</pre>

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/src/xrgb2ycrcb_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrgb2ycrcb_intr.c @addtogroup
rgb2ycrcb_v7_1 @{ This file contains interrupt related functions for the
RGB2YCRCB core. Please see xrgb2crcb.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 7.0 adk 01/28/14
First release. Implemented the following functions: XRgb2YCrCb_IntrHandler,
XRgb2YCrCb_SetCallBack. </pre>

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/src/xrgb2ycrcb_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrgb2ycrcb_selftest.c
@addtogroup rgb2ycrcb_v7_1 @{ This file contains the self-test function for the
RGB2YCRCB core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 7.0 adk 01/28/14 First Release. Implemented the following function:
XRgb2YCrCb_SelfTest. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/src/xrgb2ycrcb_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrgb2ycrcb_sinit.c @addtogroup
rgb2ycrcb_v7_1 @{ This file contains static initialization function for
RGB2YCRCB core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 7.0 adk 01/28/14 First release. Implemented following function:
XRgb2YCrCb_LookupConfig. 7.1 ms 01/16/17 Updated the parameter naming from
XPAR_RGB2YCRCB_NUM_INSTANCES to XPAR_XRGB2YCRCB_NUM_INSTANCES to avoid
compilation failure for XPAR_RGB2YCRCB_NUM_INSTANCES as the tools are generating
XPAR_XRGB2YCRCB_NUM_INSTANCES in the generated xrgb2ycrcb_g.c for fixing MISRA-C
files. This is a fix for CR-966099 based on the update in the tools. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/rgb2ycrcb/src/xrgb2ycrcb_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 kvn 4/21/15 First release 1.7 sne 2/27/19 Added
support for Versal uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/data/rtcpsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xrtcpsu_alarm_interrupt_example.c This file contains an alarm example using the
XRtcPsu driver in interrupt mode. It sets alarm for a specified time from the
current time. @note The example contains an infinite loop such that if
interrupts are not working it may hang. MODIFICATION HISTORY: <pre> Ver Who Date
Changes ----- ------ -------- 1.00 kvn 05/12/15 First Release ms 04/10/17
Modified filename tag to include the file in doxygen examples. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/examples/xrtcpsu_alarm_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrtcpsu_alarm_polled_example.c
This file contains an example using the XRtcPsu driver in polled mode. This
function sets alarm for a specified time from the current time. @note If the
device does not work properly, the example may hang. MODIFICATION HISTORY: <pre>
Ver Who Date Changes ----- ------ -------- 1.00 kvn 05/12/15 First Release
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/examples/xrtcpsu_alarm_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xrtcpsu_periodic_alarm_interrupt_example.c This file contains an periodic alarm
example using the XRtcPsu driver in interrupt mode. It sets periodical alarm for
specified times from the current time. For demontration purpose, a periodic
alarm for future 2Secs was implemented for 10 such events. @note In the example
if interrupts are not working it may hang. MODIFICATION HISTORY: <pre> Ver Who
Date Changes ----- ------ -------- 1.00 kvn 05/12/15 First Release 1.3 kvn
05/26/16 Added volatile keyword for PeriodicAlarms variable. ms 04/10/17
Modified filename tag to include the file in doxygen examples. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/examples/xrtcpsu_periodic_alarm_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xrtcpsu_seconds_interrupt_example.c This file contains an seconds example using
the XRtcPsu driver in interrupt mode. @note In the example,if interrupts are not
working it may hang. MODIFICATION HISTORY: <pre> Ver Who Date Changes -----
------ -------- 1.00 kvn 05/12/15 First Release ms 04/10/17 Modified filename
tag to include the file in doxygen examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/examples/xrtcpsu_seconds_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xrtcpsu_seconds_polled_example.c This file contains an example using the XRtcPsu
driver in polled mode. This function checks the new second reporting feature of
the RTC. @note If the device does not work properly, the example may hang.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 1.00 kvn
05/12/15 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/examples/xrtcpsu_seconds_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xrtcpsu_set_calibration_example.c This file contains an example using the
XRtcPsu driver. This function calculates new calibration value and updates the
calibration register value. @note If the device does not work properly, the
example may hang. MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------
-------- 1.00 kvn 05/12/15 First Release 1.6 tjs 09/17/18 Fixed compilation
warnings 1.8 sg 07/17/19 Update example sequence for finding new calibration
values </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/examples/xrtcpsu_set_calibration_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrtcpsu_set_time_example.c This
file contains an example using the XRtcPsu driver. This function updates the
current time. @note If the device does not work properly, the example may hang.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 1.00 kvn
05/12/15 First Release 1.6 tjs 09/17/18 Fixed compilation warnings </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/examples/xrtcpsu_set_time_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xrtcpsu.c @addtogroup
rtcpsu_v1_8 @{ Functions in this file are the minimum required functions for the
XRtcPsu driver. See xrtcpsu.h for a detailed description of the driver. @notice
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00
kvn 04/21/15 First release 1.1 kvn 09/25/15 Modify control register to enable
battery switching when vcc_psaux is not available. 1.2 02/15/16 Corrected
Calibration mask and Fractional mask in CalculateCalibration API. 1.3 vak
04/25/16 Corrected the RTC read and write time logic(cr948833). 1.5 ms 08/27/17
Fixed compilation warnings. ms 08/29/17 Updated code as per source code style.
1.6 aru 06/25/18 Modified logic to handle the last day of month
cotrrecly.(CR1004282) 1.6 aru 06/25/18 Remove the checkpatch warnings. 1.6 aru
07/11/18 Resolved cppcheck warnings. 1.6 aru 07/11/18 Resolved doxygen warnings.
1.6 aru 08/17/18 Resolved MISRA-C mandatory violations.(CR1007752) 1.7 sne
03/01/19 Added Versal support. 1.7 sne 03/01/19 Fixed violations according to
MISRAC-2012 standards modified the code such as No brackets to loop
body,Declared the poiner param as Pointer to const,No brackets to then/else,
Literal value requires a U suffix,Casting operation to a pointer Array has no
bounds specified,Logical conjunctions need brackets. 1.8 sg 07/13/19 Corrected
calibration algorithm </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/src/xrtcpsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xrtcpsu.h @addtogroup
rtcpsu_v1_8 @{ @details The Xilinx RTC driver component. This component supports
the Xilinx RTC Controller. RTC Core and RTC controller are the two main
important sub components for this RTC module. RTC core can run even in the
battery powered domain when the power from auxiliary source is down.Because of
this, RTC core latches the calibration,programmed time.This core interfaces with
the crystal oscillator and maintains current time in seconds.Calibration
circuitry calculates a second with maximum 1 PPM inaccuracy using a crystal
oscillator with arbitrary static inaccuracy. Core also responsible to maintain
control value used by the oscillator and power switching circuitry. RTC
controller includes an APB interface responsible for register access with in
controller and core.It contains alarm generation logic including the alarm
register to hold alarm time in seconds.Interrupt management using Interrupt
status, Interrupt mask, Interrupt enable, Interrupt disable registers are
included to manage alarm and seconds interrupts.Address Slave error interrupts
are not being handled by this driver component. This driver supports the
following features: - Setting the RTC time. - Setting the Alarm value that can
be one-time alarm or a periodic alarm. - Modifying the calibration value.
<b>Initialization & Configuration</b> The XRtcPsu_Config structure is used by
the driver to configure itself. Fields inside this structure are properties of
XRtcPsu based on its hardware build. To support multiple runtime loading and
initialization strategies employed by various operating systems, the driver
instance can be initialized in the following way: -
XRtcPsu_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) - Uses a configuration
structure provided by the caller. If running in a system with address
translation, the parameter EffectiveAddr should be the virtual address.
<b>Interrupts</b> The driver defaults to no interrupts at initialization such
that interrupts must be enabled if desired. An interrupt is generated for one of
the following conditions. - Alarm is generated. - A new second is generated. The
application can control which interrupts are enabled using the
XRtcPsu_SetInterruptMask() function. In order to use interrupts, it is necessary
for the user to connect the driver interrupt handler,
XRtcPsu_InterruptHandler(), to the interrupt system of the application. A
separate handler should be provided by the application to communicate with the
interrupt system, and conduct application specific interrupt handling. An
application registers its own handler through the XRtcPsu_SetHandler() function.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00 kvn
04/21/15 First release 1.1 kvn 09/25/15 Modify control register to enable
battery switching when vcc_psaux is not available. 1.3 vak 04/25/16 Corrected
the RTC read and write time logic(cr948833). 1.4 MNK 01/27/17 Corrected
calibration and frequency macros based on rtc input oscillator frequency (
32.768Khz). ms 03/17/17 Added readme.txt file in examples folder for doxygen
generation. ms 04/10/17 Modified filename tag in examples to include them in
doxygen examples. 1.5 ms 08/27/17 Fixed compilation warnings in xrtcpsu.c file.
ms 08/29/17 Updated the code as per source code style. 1.6 aru 06/25/18 Modified
logic to handle the last day of month cotrrecly.(CR1004282) 1.6 aru 06/25/18
Remove the checkpatch warnings. 1.6 aru 07/11/18 Resolved cppcheck warnings. 1.6
aru 07/11/18 Resolved doxygen warnings. 1.6 aru 08/17/18 Resolved MISRA-C
mandatory violations.(CR1007752) 1.6 tjs 09/17/18 Fixed compilation warnings.
1.7 sne 03/01/19 Added Versal support. 1.7 sne 03/01/19 Fixed violations
according to MISRAC-2012 standards modified the code such as No brackets to loop
body,Declared the poiner param as Pointer to const,No brackets to then/else,
Literal value requires a U suffix,Casting operation to a pointer Array has no
bounds specified,Logical conjunctions need brackets. </pre> /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/src/xrtcpsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrtcpsu_g.c @addtogroup
rtcpsu_v1_8 @{ This file contains a configuration table that specifies the
configuration of CAN devices in the system. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ----- -------- 1.00 kvn 04/21/15 First release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/src/xrtcpsu_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrtcpsu_hw.h @addtogroup
rtcpsu_v1_8 @{ This header file contains the identifiers and basic driver
functions (or macros) that can be used to access the device. Other driver
functions are defined in xrtcpsu.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.00a kvn 04/21/15 First release 1.1 kvn 09/25/15
Modify control register to enable battery switching when vcc_psaux is not
available. </pre>

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/src/xrtcpsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrtcpsu_intr.c @addtogroup
rtcpsu_v1_8 @{ This file contains functions related to RTC interrupt handling.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00 kvn
04/21/15 First release 1.3 vak 04/25/16 Changed the XRtcPsu_InterruptHandler()
for updating RTC read and write time logic(cr948833). 1.6 aru 08/17/18 Resolved
MISRA-C mandatory violations.(CR1007752) 1.7 sne 03/01/19 Added Versal support.
1.7 sne 03/01/19 Fixed violations according to MISRAC-2012 standards modified
the code such as No brackets to loop body,Declared the poiner param as Pointer
to const,No brackets to then/else, Literal value requires a U suffix,Casting
operation to a pointer Array has no bounds specified,Logical conjunctions need
brackets. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/src/xrtcpsu_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrtcpsu_selftest.c @addtogroup
rtcpsu_v1_8 @{ This file contains the self-test functions for the XRtcPsu
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 kvn 04/21/15 First release. 1.7 sne 03/01/19 Added Versal support. 1.7 sne
03/01/19 Fixed violations according to MISRAC-2012 standards modified the code
such as No brackets to loop body,Declared the poiner param as Pointer to
const,No brackets to then/else, Literal value requires a U suffix,Casting
operation to a pointer Array has no bounds specified,Logical conjunctions need
brackets. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/src/xrtcpsu_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xrtcpsu_sinit.c @addtogroup
rtcpsu_v1_8 @{ This file contains the implementation of the XRtcPsu driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00 kvn 04/21/15 First release. 1.7 sne
03/01/19 Added Versal support. 1.7 sne 03/01/19 Fixed violations according to
MISRAC-2012 standards modified the code such as No brackets to loop
body,Declared the poiner param as Pointer to const,No brackets to then/else,
Literal value requires a U suffix,Casting operation to a pointer Array has no
bounds specified,Logical conjunctions need brackets. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/rtcpsu/src/xrtcpsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 04/18/11 Created 1.05a hk 06/26/13
Modified to export external interrupts correctly to xparameters.h. Fix for CR's
690505, 708928 & 719359 2.0 adk 12/10/13 Updated as per the New Tcl API's 2.1
adk 25/04/14 Added support for corenIRQ/FIQ interrupts.Fix for the CR789373 3.0
pkp 12/09/14 Added support for Zynq Ultrascale Mp 3.2 pkp 27/01/16 Added the
support for PL IP interrupts for ZynqMP Soc 3.2 pkp 09/03/16 Compute the
interrupt ID instead of reading from interrupt pin property for PL ips in
get_psu_interrupt_id for zynqmpsoc to fix CR940127 3.4 pkp 29/06/16 Updated
get_psu_interrupt_id to return correct PL ips' interruptIDs when no interrupt is
connected to pl_ps_irq0 3.5 mus 14/10/16 Modified xdefine_gic_params and
get_psu_interrupt_id functions to get correct PL-PS interrupt IDs.Fix for the
CR961257 3.6 pkp 01/22/17 Modified xdefine_zynq_canonical_xpars and
xdefine_zynq_include_file to add hypervisor guest application support for
cortex-a53 64bit mode 3.7 ms 04/11/17 Modified tcl file to add U suffix for all
macros in xparameters.h 3.8 mus 05/25/17 Updated proc xdefine_gic_params to
declare "valid_periph" variable at start of the proc, to avoid the tcl errors in
case of unsupported processor.It fixes CR976861 3.8 mus 07/05/17 Added support
for interrupts connected through util_reduced_vector IP(OR gate). 3.8 mus
07/05/17 Updated xdefine_zynq_canonical_xpars proc to initialize the
HandlerTable in XScuGic_ConfigTable to 0, it removes the compilation warning in
xscugic_g.c. Fix for CR978736. 3.8 mus 07/25/17 Updated xdefine_gic_params proc
to export correct canonical definitions for pl to ps interrupts.Fix for CR980534
3.8 mus 08/17/17 Updated get_psu_interrupt_id proc to check if the sink pin is
connected to peripheral.Fix for CR980414. 3.10 mus 04/23/18 Updated
get_psu_interrupt_id to generate correct interrupt id's, when output of utility
reduced logic is connected to pl-ps interrupt as well as ILA probe. Fix for
CR999732. 3.10 mus 09/10/18 Added -hier option while using get_cells command to
support hierarchical designs. 3.10 mus 10/05/18 Updated get_psu_interrupt_id
proc to return multiple interrupt ID's, in case if specific interrupt port of PL
based IP is connected to the pl_ps_irq0 and pl_ps_irq1 directly or through same
concat block pin. Fix for CR100266. 3.10 mus 10/05/18 Updated
get_psu_interrupt_id proc, to fix interrupt id computation for vectored
interrupts. It fixes CR998583 4.0 mus 04/15/19 Updated get_concat_number proc to
avoid executing get_pins command twice. It fixes CR1028356 4.1 mus 04/09/19 Add
pl-ps interrupt id generation support for versal 4.1 mus 06/20/19 Updated
get_concat_number proc to check if common::get_property LEFT is returning empty.
It fixes CR1033637. 4.1 mus 07/09/19 Unlike ZynqMP, Versal doesnt have
IRQ0_F2P/IRQ01_F2P ports and interrupt source from PL can be directly connected
to the pl_ps_irq0, pl_ps_irq1...pl_ps_irq15 pins. Updated get_psu_interrupt_id
proc to generate correct pl-ps interrupt IDs for Versal. It fixes CR1017942 uses
"xillib.tcl" "generate" procedure

FILES:
XilinxProcessorIPLib/drivers/scugic/data/scugic.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a sdm 05/24/11 First release 3.0 adk 12/10/13
Updated as per the New Tcl API's Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software
Project Types (swproj): 0 : MemoryTest - Calls basic memorytest routines 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/scugic/data/scugic_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_example.c This file
contains a design example using the Interrupt Controller driver (XScuGic) and
hardware device. Please reference other device driver examples to see more
examples of how the intc and interrupts can be used by a software application.
@note None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a drg 01/18/10 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/examples/xscugic_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_low_level_example.c
This file contains a design example using the low level driver, interface of the
Interrupt Controller driver. This example shows the use of the Interrupt
Controller with the ARM processor. @note none <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a drg 01/30/10 First release 3.10 mus
09/19/18 Update prototype of LowInterruptHandler to fix the GCC warning 4.0 mus
01/28/19 Updated to support Cortexa72 GIC (GIC500). </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/examples/xscugic_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_tapp_example.c This
file contains a self test example using the Interrupt Controller driver
(XScuGic) and hardware device. Please reference other device driver examples to
see more examples of how the Intc and interrupts can be used by a software
application. The TestApp Gen utility uses this file to perform the self test and
setup of Intc for interrupts. @note None <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a sdm 05/29/11 Created for Test App
Integration 3.6 ms 01/23/17 Modified xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/examples/xscugic_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic.c @addtogroup
scugic_v4_0 @{ Contains required functions for the XScuGic driver for the
Interrupt Controller. See xscugic.h for a detailed description of the driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a drg
01/19/10 First release 1.01a sdm 11/09/11 Changes are made in function
XScuGic_CfgInitialize Since entry is now made as pointer in the XScuGic
structure, necessary changes are made. The HandlerTable can now be populated
through the low level routine XScuGic_RegisterHandler added in this release.
Hence necessary checks are added not to overwrite the HandlerTable entriesin
function XScuGic_CfgInitialize. 1.03a srt 02/27/13 Added APIs
-XScuGic_SetPriTrigTypeByDistAddr() -XScuGic_GetPriTrigTypeByDistAddr() Removed
Offset calculation macros, defined in _hw.h (CR 702687) added support to direct
interrupts to the appropriate CPU Earlier interrupts were directed to CPU1 (hard
coded).Now depending upon the CPU selected by the user(xparameters.h),
interrupts will be directed to the relevant CPU. This fixes CR 699688. 1.04a hk
05/04/13 Assigned EffectiveAddr to CpuBaseAddress in XScuGic_CfgInitialize. Fix
for CR704400 to remove warnings. Moved functions
XScuGic_SetPriTrigTypeByDistAddr and XScuGic_GetPriTrigTypeByDistAddr to
xscugic_hw.c. This is fix for CR705621. 1.06a asa 16/11/13 Fix for CR749178.
Assignment for EffectiveAddr in function XScuGic_CfgInitialize is removed as it
was a bug. 3.00 kvn 02/13/14 Modified code for MISRA-C:2012 compliance. 3.01 pkp
06/19/15 Added XScuGic_InterruptMaptoCpu API for an interrupt target CPU mapping
3.02 pkp 11/09/15 Modified DistributorInit function for AMP case to add the
current cpu to interrupt processor targets registers 3.2 asa 02/29/16 Modified
DistributorInit function for Zynq AMP case. The distributor is left
uninitialized for Zynq AMP. It is assumed that the distributor will be
initialized by Linux master. However for CortexR5 case, the earlier code is left
unchanged where the the interrupt processor target registers in the distributor
is initialized with the corresponding CPU ID on which the application built over
the scugic driver runs. These changes fix CR937243. 3.3 pkp 05/12/16 Modified
XScuGic_InterruptMaptoCpu to write proper value to interrupt target register to
fix CR951848 3.4 asa 04/07/16 Created a new static function DoDistributorInit to
simplify the flow and avoid code duplication. Changes are made for USE_AMP use
case for R5. In a scenario (in R5 split mode) when one R5 is operating with A53
in open amp config and other R5 running baremetal app, the existing code had the
potential to stop the whole AMP solution to work(if for some reason the R5
running the baremetal app tasked to initialize the Distributor hangs or crashes
before initializing).Changes are made so that the R5 under AMP first checks if
the distributor is enabled or not and if not, it does the standard Distributor
initialization.This fixes the CR952962. 3.4 mus 09/08/16 Added assert to avoid
invalid access of GIC from CPUID 1 for single core zynq-7000s 3.5 mus 10/05/16
Modified DistributorInit function to avoid re-initialization of distributor, If
it is already initialized by other CPU. 3.5 pkp 10/17/16 Modified
XScuGic_InterruptMaptoCpu to correct the CPU Id value and properly mask
interrupt target processor value to modify interrupt target processor register
for a given interrupt ID and cpu ID 3.6 pkp 20/01/17 Added new API XScuGic_Stop
to Disable distributor and interrupts in case they are being used only by
current cpu. It also removes current cpu from interrupt target registers for all
interrupts. kvn 02/17/17 Add support for changing GIC CPU master at run time.
kvn 02/28/17 Make the CpuId as static variable and Added new XScugiC_GetCpuId to
access CpuId. 3.9 mus 02/21/18 Added new API's XScuGic_UnmapAllInterruptsFromCpu
and XScuGic_InterruptUnmapFromCpu, These API's can be used by applications to
unmap specific/all interrupts from target CPU. It fixes CR992490. 3.10 mus
07/17/18 Updated file to fix the various coding style issues reported by
checkpatch. It fixes CR1006344. 3.10 aru 08/23/18 Resolved MISRA-C:2012
compliance mandatory violations It fixes CR1007753. 3.10 mus 09/19/18 Fix
cppcheck warnings 4.0 mus 11/22/18 Fixed bugs in software interrupt generation
through XScuGic_SoftwareIntr API 4.1 asa 03/30/19 Made changes not to direct
each interrupt to all available CPUs by default. This was breaking AMP behavior.
Instead every time an interrupt enable request is received, the interrupt was
mapped to the respective CPU. There were several other changes made to implement
this. This set of changes was to fix CR-1024716. 4.1 mus 06/19/19 Added API's
XScuGic_MarkCoreAsleep and XScuGic_MarkCoreAwake to mark processor core as
asleep or awake. Fix for CR1027220. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic.h @addtogroup
scugic_v4_0 @{ @details The generic interrupt controller driver component. The
interrupt controller driver uses the idea of priority for the various handlers.
Priority is an integer within the range of 1 and 31 inclusive with default of 1
being the highest priority interrupt source. The priorities of the various
sources can be dynamically altered as needed through hardware configuration. The
generic interrupt controller supports the following features: - specific
individual interrupt enabling/disabling - specific individual interrupt
acknowledging - attaching specific callback function to handle interrupt source
- assigning desired priority to interrupt source if default is not acceptable.
Details about connecting the interrupt handler of the driver are contained in
the source file specific to interrupt processing, xscugic_intr.c. This driver is
intended to be RTOS and processor independent. It works with physical addresses
only. Any needs for dynamic memory management, threads or thread mutual
exclusion, virtual memory, or cache control must be satisfied by the layer above
this driver. <b>Interrupt Vector Tables</b> The device ID of the interrupt
controller device is used by the driver as a direct index into the configuration
data table. The user should populate the vector table with handlers and
callbacks at run-time using the XScuGic_Connect() and XScuGic_Disconnect()
functions. Each vector table entry corresponds to a device that can generate an
interrupt. Each entry contains an interrupt handler function and an argument to
be passed to the handler when an interrupt occurs. The user must use
XScuGic_Connect() when the interrupt handler takes an argument other than the
base address. <b>Nested Interrupts Processing</b> Nested interrupts are not
supported by this driver. NOTE: The generic interrupt controller is not a part
of the snoop control unit as indicated by the prefix "scu" in the name of the
driver. It is an independent module in APU. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a drg 01/19/00 First release 1.01a sdm
11/09/11 The XScuGic and XScuGic_Config structures have changed. The
HandlerTable (of type XScuGic_VectorTableEntry) is moved to XScuGic_Config
structure from XScuGic structure. The "Config" entry in XScuGic structure is
made as pointer for better efficiency. A new file named as xscugic_hw.c is now
added. It is to implement low level driver routines without using any xscugic
instance pointer. They are useful when the user wants to use xscugic through
device id or base address. The driver routines provided are explained below.
XScuGic_DeviceInitialize that takes device id as argument and initializes the
device (without calling XScuGic_CfgInitialize). XScuGic_DeviceInterruptHandler
that takes device id as argument and calls appropriate handlers from the
HandlerTable. XScuGic_RegisterHandler that registers a new handler by taking
xscugic hardware base address as argument. LookupConfigByBaseAddress is used to
return the corresponding config structure from XScuGic_ConfigTable based on the
scugic base address passed. 1.02a sdm 12/20/11 Removed AckBeforeService from the
XScuGic_Config structure. 1.03a srt 02/27/13 Moved Offset calculation macros
from .c and _hw.c to _hw.h Added APIs - XScuGic_SetPriTrigTypeByDistAddr() -
XScuGic_GetPriTrigTypeByDistAddr() (CR 702687) Added support to direct
interrupts to the appropriate CPU. Earlier interrupts were directed to CPU1
(hard coded). Now depending upon the CPU selected by the user (xparameters.h),
interrupts will be directed to the relevant CPU. This fixes CR 699688. 1.04a hk
05/04/13 Assigned EffectiveAddr to CpuBaseAddress in XScuGic_CfgInitialize. Fix
for CR704400 to remove warnings. Moved functions
XScuGic_SetPriTrigTypeByDistAddr and XScuGic_GetPriTrigTypeByDistAddr to
xscugic_hw.c. This is fix for CR705621. 1.05a hk 06/26/13 Modified tcl to export
external interrupts correctly to xparameters.h. Fix for CR's 690505, 708928 &
719359. 2.0 adk 12/10/13 Updated as per the New Tcl API's 2.1 adk 25/04/14 Fixed
the CR:789373 changes are made in the driver tcl file. 3.00 kvn 02/13/15
Modified code for MISRA-C:2012 compliance. 3.2 asa 02/29/16 Modified
DistributorInit function for Zynq AMP case. The distributor is left
uninitialized for Zynq AMP. It is assumed that the distributor will be
initialized by Linux master. However for CortexR5 case, the earlier code is left
unchanged where the the interrupt processor target registers in the distributor
is initialized with the corresponding CPU ID on which the application built over
the scugic driver runs. These changes fix CR937243. 3.4 asa 04/07/16 Created a
new static function DoDistributorInit to simplify the flow and avoid code
duplication. Changes are made for USE_AMP use case for R5. In a scenario (in R5
split mode) when one R5 is operating with A53 in open amp config and other R5
running baremetal app, the existing code had the potential to stop the whole AMP
solution to work (if for some reason the R5 running the baremetal app tasked to
initialize the Distributor hangs or crashes before initializing). Changes are
made so that the R5 under AMP first checks if the distributor is enabled or not
and if not, it does the standard Distributor initialization. This fixes the
CR952962. 3.6 ms 01/23/17 Modified xil_printf statement in main function for all
examples to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. kvn 02/17/17 Add support for changing
GIC CPU master at run time. kvn 02/28/17 Make the CpuId as static variable and
Added new XScugiC_GetCpuId to access CpuId. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. 3.7 ms 04/11/17 Modified tcl file to add
suffix U for all macro definitions of scugic in xparameters.h 3.8 mus 07/05/17
Updated scugic.tcl to add support for interrupts connected through
util_reduced_vector IP(OR gate) mus 07/05/17 Updated
xdefine_zynq_canonical_xpars proc to initialize the HandlerTable in
XScuGic_ConfigTable to 0, it removes the compilation warning in xscugic_g.c. Fix
for CR978736. mus 07/25/17 Updated xdefine_gic_params proc to export correct
canonical definitions for pl to ps interrupts.Fix for CR980534 3.9 mus 02/21/18
Added new API's XScuGic_UnmapAllInterruptsFromCpu and
XScuGic_InterruptUnmapFromCpu, These API's can be used by applications to unmap
specific/all interrupts from target CPU. 3.10 aru 08/23/18 Resolved MISRA-C:2012
compliance mandatory violations 4.0 mus 11/22/18 Fixed bugs in software
interrupt generation through XScuGic_SoftwareIntr API 4.1 asa 03/30/19 Made
changes not to direct each interrupt to all available CPUs by default. This was
breaking AMP behavior. Instead every time an interrupt enable request is
received, the interrupt was mapped to the respective CPU. There were several
other changes made to implement this. This set of changes was to fix CR-1024716.
4.1 mus 06/19/19 Added API's XScuGic_MarkCoreAsleep and XScuGic_MarkCoreAwake to
mark processor core as asleep or awake. Fix for CR1027220. </pre>

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_g.c @addtogroup
scugic_v4_0 @{ This file contains a configuration table that specifies the
configuration of interrupt controller devices in the system. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a drg 01/19/10 First
release 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.10 mus
07/17/18 Updated file to fix the various coding style issues reported by
checkpatch. It fixes CR1006344. </pre> @internal This configuration table
contains entries that are modified at runtime by the driver. This table reflects
only the hardware configuration of the device. This Intc configuration table
contains software information in addition to hardware configuration. Include
Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_hw.c @addtogroup
scugic_v4_0 @{ This file contains low-level driver functions that can be used to
access the device. The user should refer to the hardware device specification
for more details of the device operation. These routines are used when the user
does not want to create an instance of XScuGic structure but still wants to use
the ScuGic device. Hence the routines provided here take device id or scugic
base address as arguments. Separate static versions of DistInit and CPUInit are
provided to implement the low level driver routines. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.01a sdm 07/18/11 First release 1.03a
srt 02/27/13 Moved Offset calculation macros from _hw.c (CR 702687). Added
support to direct interrupts to the appropriate CPU. Earlier interrupts were
directed to CPU1 (hard coded). Now depending upon the CPU selected by the user
(xparameters.h), interrupts will be directed to the relevant CPU.This fixes CR
699688. 1.04a hk 05/04/13 Fix for CR705621. Moved functions
XScuGic_SetPriTrigTypeByDistAddr and XScuGic_GetPriTrigTypeByDistAddr here from
xscugic.c 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.6 kvn
02/17/17 Add support for changing GIC CPU master at run time. kvn 02/28/17 Make
the CpuId as static variable and Added new XScugiC_GetCpuId to access CpuId. 3.9
mus 02/21/18 Added new API's XScuGic_InterruptUnmapFromCpuByDistAddr and
XScuGic_UnmapAllInterruptsFromCpuByDistAddr, These API's can be used by
applications to unmap specific/all interrupts from target CPU. It fixes
CR992490. 3.10 mus 07/17/18 Updated XScuGic_DeviceInterruptHandler to fix array
overrun reported by coverity tool. It fixes CR1006344. 3.10 mus 07/17/18 Updated
file to fix the various coding style issues reported by checkpatch. It fixes
CR1006344. 3.10 aru 08/23/18 Resolved MISRA-C:2012 compliance mandatory
violations It fixes CR1007753 3.10 mus 09/19/18 Update documentation for
XScuGic_RegisterHandler to fix doxygen warnings. 4.1 asa 03/30/19 Made changes
not to direct each interrupt to all available CPUs by default. This was breaking
AMP behavior. Instead every time an interrupt enable request is received, the
interrupt was mapped to the respective CPU. There were several other changes
made to implement this including adding APIs:
XScuGic_InterruptMapFromCpuByDistAddr, XScuGic_EnableIntr, and
XScuGic_DisableIntr. This set of changes was to fix CR-1024716. 4.1 mus 06/12/19
Updated existing low level API's to support GIC500. It fixes CR1033401. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_hw.h @addtogroup
scugic_v4_0 @{ This header file contains identifiers and HW access functions (or
macros) that can be used to access the device. The user should refer to the
hardware device specification for more details of the device operation. The
driver functions/APIs are defined in xscugic.h. This GIC device has two parts, a
distributor and CPU interface(s). Each part has separate register definition
sections. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a drg 01/19/10 First release 1.01a sdm 11/09/11 "xil_exception.h" added as
include. Macros XScuGic_EnableIntr and XScuGic_DisableIntr are added to enable
or disable interrupts based on Distributor Register base address. Normally users
use XScuGic instance and call XScuGic_Enable or XScuGic_Disable to
enable/disable interrupts. These new macros are provided when user does not want
to use an instance pointer but still wants to enable or disable interrupts.
Function prototypes for functions (present in newly added file xscugic_hw.c) are
added. 1.03a srt 02/27/13 Moved Offset calculation macros from _hw.c (CR
702687). 1.04a hk 05/04/13 Fix for CR705621. Moved function prototypes
XScuGic_SetPriTrigTypeByDistAddr and XScuGic_GetPriTrigTypeByDistAddr here from
xscugic.h 3.0 pkp 12/09/14 changed XSCUGIC_MAX_NUM_INTR_INPUTS for Zynq
Ultrascale Mp 3.0 kvn 02/13/14 Modified code for MISRA-C:2012 compliance. 3.2
pkp 11/09/15 Corrected the interrupt processsor target mask value for CPU
interface 2 i.e. XSCUGIC_SPI_CPU2_MASK 3.9 mus 02/21/18 Added new API's
XScuGic_InterruptUnmapFromCpuByDistAddr and
XScuGic_UnmapAllInterruptsFromCpuByDistAddr, These API's can be used by
applications to unmap specific/all interrupts from target CPU. It fixes
CR992490. 3.10 aru 08/23/18 Resolved MISRA-C:2012 compliance mandatory
violations 4.1 asa 03/30/19 Removed macros for XScuGic_EnableIntr, and
XScuGic_DisableIntr. These are now C functions. This change was to fix
CR-1024716. 4.1 mus 06/12/19 Updated XSCUGIC_MAX_NUM_INTR_INPUTS for Versal.
</pre>

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_intr.c @addtogroup
scugic_v4_0 @{ This file contains the interrupt processing for the driver for
the Xilinx Interrupt Controller. The interrupt processing is partitioned
separately such that users are not required to use the provided interrupt
processing. This file requires other files of the driver to be linked in also.
The interrupt handler, XScuGic_InterruptHandler, uses an input argument which is
an instance pointer to an interrupt controller driver such that multiple
interrupt controllers can be supported. This handler requires the calling
function to pass it the appropriate argument, so another level of indirection
may be required. The interrupt processing may be used by connecting the
interrupt handler to the interrupt system. The handler does not save and restore
the processor context but only handles the processing of the Interrupt
Controller. The user is encouraged to supply their own interrupt handler when
performance tuning is deemed necessary. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a drg 01/19/10 First release 1.01a sdm 11/09/11
XScuGic_InterruptHandler has changed correspondingly since the HandlerTable has
now moved to XScuGic_Config. 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. 3.10 mus 07/17/18 Updated XScuGic_InterruptHandler to fix array
overrun reported by coverity tool. It fixes CR1006344. 3.10 mus 07/17/18 Updated
file to fix the various coding style issues reported by checkpatch. It fixes
CR1006344. </pre> @internal This driver assumes that the context of the
processor has been saved prior to the calling of the Interrupt Controller
interrupt handler and then restored after the handler returns. This requires
either the running RTOS to save the state of the machine or that a wrapper be
used as the destination of the interrupt vector to save the state of the
processor and restore the state after the interrupt handler returns. Include
Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_selftest.c @addtogroup
scugic_v4_0 @{ Contains diagnostic self-test functions for the XScuGic driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a drg
01/19/10 First release 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. 3.10 mus 07/17/18 Updated file to fix the various coding style
issues reported by checkpatch. It fixes CR1006344. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscugic_sinit.c @addtogroup
scugic_v4_0 @{ Contains static init functions for the XScuGic driver for the
Interrupt Controller. See xscugic.h for a detailed description of the driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a drg
01/19/10 First release 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. 3.10 mus 07/17/18 Updated file to fix the various coding style
issues reported by checkpatch. It fixes CR1006344. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scugic/src/xscugic_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer_intr_example.c This
file contains a design example using the Cortex A9 Scu Private Timer and the
driver (XScuTimer) using interrupts. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a nm 03/10/10 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/scutimer/examples/xscutimer_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer_polled_example.c This
file contains a design example using the Scu Private Timer driver (XScuTimer)
and hardware timer device. This test assumes Auto Reload mode is not enabled.
@note None. MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ---- --------
1.00a nm 03/10/10 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scutimer/examples/xscutimer_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer.c @addtogroup
scutimer_v2_1 @{ Contains the implementation of interface functions of the SCU
Timer driver. See xscutimer.h for a description of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a nm 03/10/10
First release 2.1 sk 02/26/15 Modified the code for MISRA-C:2012 compliance.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scutimer/src/xscutimer.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer.h @addtogroup
scutimer_v2_1 @{ @details The timer driver supports the Cortex A9 private timer.
The timer driver supports the following features: - Normal mode and Auto reload
mode - Interrupts (Interrupt handler is not provided in this driver. Application
has to register it's own handler) <b> Initialization and Configuration </b> The
device driver enables higher layer software (e.g., an application) to
communicate with the Timer. XScuTimer_CfgInitialize() API is used to initialize
the Timer. The user needs to first call the XScuTimer_LookupConfig() API which
returns the Configuration structure pointer which is passed as a parameter to
the XScuTimer_CfgInitialize() API. <b> Interrupts </b> The Timer hardware
supports interrupts. This driver does not provide a Interrupt Service Routine
(ISR) for the device. It is the responsibility of the application to provide one
if needed. Refer to the interrupt example provided with this driver for details
on using the Timer in interrupt mode. <b> Virtual Memory </b> This driver
supports Virtual Memory. The RTOS is responsible for calculating the correct
device base address in Virtual Memory space. <b> Threads </b> This driver is not
thread safe. Any needs for threads or thread mutual exclusion must be satisfied
by the layer above this driver. <b> Asserts </b> Asserts are used within all
Xilinx drivers to enforce constraints on argument values. Asserts can be turned
off on a system-wide basis by defining, at compile time, the NDEBUG identifier.
By default, asserts are turned on and it is recommended that users leave asserts
on during development. <b> Building the driver </b> The XScuTimer driver is
composed of several source files. This allows the user to build and link only
those parts of the driver that are necessary. <br><br> NOTE: The timer is not a
part of the snoop control unit as indicated by the prefix "scu" in the name of
the driver. It is an independent module in APU. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.00a nm 03/10/10 First release 1.02a sg
07/17/12 Included xil_assert.h for CR 667947. This is an issue when the
xstatus.h in the common driver overwrites the xstatus.h of the standalone BSP
during the libgen. 2.1 sk 02/26/15 Modified the code for MISRA-C:2012
compliance. ms 03/17/17 Added readme.txt file in examples folder for doxygen
generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/scutimer/src/xscutimer.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer_g.c @addtogroup
scutimer_v2_1 @{ This file contains a table that specifies the configuration of
the SCU Timer in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- --- -------- 1.00a nm 03/10/10 First release 2.1 sk 02/26/15 Modified the
code for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scutimer/src/xscutimer_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer_hw.h @addtogroup
scutimer_v2_1 @{ This file contains the hardware interface to the Timer. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a nm 03/10/10
First release 1.01a sdm 02/02/12 Added low level macros to read/write load,
counter, control and interrupt registers 1.02a sg 07/17/12 Included xil_assert.h
for CR 667947. This is an issue when the xstatus.h in the common driver
overwrites the xstatus.h of the standalone BSP during the libgen. 2.1 sk
02/26/15 Modified the code for MISRA-C:2012 compliance. </pre>

FILES:
XilinxProcessorIPLib/drivers/scutimer/src/xscutimer_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer_selftest.c
@addtogroup scutimer_v2_1 @{ Contains diagnostic self-test functions for the
XScuTimer driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a nm 03/10/10 First release 2.1 sk 02/26/15 Modified the code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scutimer/src/xscutimer_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscutimer_sinit.c @addtogroup
scutimer_v2_1 @{ This file contains method for static initialization (compile-
time) of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a nm 03/10/10 First release 2.1 sk 02/26/15 Modified the code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scutimer/src/xscutimer_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt_intr_example.c This
file contains a design example using the Xilinx SCU Private Watchdog Timer
driver (XScuWdt) and hardware in Timer mode using interrupts. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sdm
01/15/10 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scuwdt/examples/xscuwdt_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt_polled_example.c This
file contains a design example using the Xilinx SCU Private Watchdog Timer
driver (XScuWdt) and hardware device in watchdog mode. This test illustrates how
to initialize the watchdog device and restart it periodially to avoid the
assertion of the WDRESETREQ pin. @note None. MODIFICATION HISTORY: <pre> Ver Who
Date Changes ----- ---- -------- 1.00a sdm 01/15/10 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/scuwdt/examples/xscuwdt_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt.c @addtogroup
scuwdt_v2_1 @{ Contains the implementation of interface functions of the XScuWdt
driver. See xscuwdt.h for a description of the driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.00a sdm 01/15/10 First
release 2.1 sk 02/26/15 Modified the code for MISRA-C:2012 compliance. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/scuwdt/src/xscuwdt.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt.h @addtogroup
scuwdt_v2_1 @{ @details The Xilinx SCU watchdog timer driver (XScuWdt) supports
the Xilinx SCU private watchdog timer hardware. The XScuWdt driver supports the
following features: - Watchdog mode - Timer mode - Auto reload (timer mode only)
The watchdog counter register is a down counter and starts decrementing when the
watchdog is started. In watchdog mode, when the counter reaches 0, the Reset
flag is set in the Reset status register and the WDRESETREQ pin is asserted,
causing a system reset. The Reset flag is not reset by normal processor reset
and is cleared when written with a value of 1. This enables the user to
differentiate a normal reset and a reset caused by watchdog time-out. The user
needs to call XScuWdt_RestartWdt() periodically, to avoid the watchdog from
being timed-out. The IsWdtExpired function can be used to check if the watchdog
was the cause of the last reset. In this situation, call Initialize then call
IsWdtExpired. If the result is true, watchdog timeout caused the last system
reset. The application then needs to clear the Reset flag. In timer mode, when
the counter reaches 0, the Event flag is set in the Interrupt status register
and if interrupts are enabled, interrupt ID 30 is set as pending in the
interrupt distributor. The IsTimerExpired function is used to check if the
watchdog counter has decremented to 0 in timer mode. If auto-reload mode is
enabled, the Counter register is automatically reloaded from the Load register.
<b> Initialization and Configuration </b> The device driver enables higher layer
software (e.g., an application) to communicate with the Watchdog Timer.
XScuWdt_CfgInitialize() API is used to initialize the Watchdog Timer. The user
needs to first call the XScuWdt_LookupConfig() API which returns the
Configuration structure pointer which is passed as a parameter to the
XScuWdt_CfgInitialize() API. <b>Interrupts</b> The SCU Watchdog Timer supports
interrupts in Timer mode. This driver does not provide a Interrupt Service
Routine (ISR) for the device. It is the responsibility of the application to
provide one if needed. Refer to the interrupt example provided with this driver
for details on using the Timer in interrupt mode. <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b> Building the driver </b> The XScuWdt
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <br><br> NOTE: The
watchdog timer is not a part of the snoop control unit as indicated by the
prefix "scu" in the name of the driver. It is an independent module in APU.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a sdm
01/15/10 First release 1.02a sg 07/17/12 Included xil_assert.h for CR 667947.
This is an issue when the xstatus.h in the common driver overwrites the
xstatus.h of the standalone BSP during the libgen. 2.1 sk 02/26/15 Modified the
code for MISRA-C:2012 compliance. ms 03/17/17 Added readme.txt file in examples
folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/scuwdt/src/xscuwdt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt_g.c @addtogroup
scuwdt_v2_1 @{ This file contains a table that specifies the configuration of
the SCU watchdog timer devices in the system. Each device should have an entry
in the table. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a sdm 01/15/10 First release 2.1 sk 02/26/15 Modified the code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scuwdt/src/xscuwdt_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt_hw.h @addtogroup
scuwdt_v2_1 @{ This file contains the hardware interface to the Xilinx SCU
private Watch Dog Timer (XSCUWDT). <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00a sdm 01/15/10 First release 1.01a bss 02/27/12
Updated the register offsets to start at 0x0 instead of 0x20 as the base address
obtained from the tools starts at 0x20. 1.02a sg 07/17/12 Included xil_assert.h
for CR 667947. This is an issue when the xstatus.h in the common driver
overwrites the xstatus.h of the standalone BSP during the libgen. 2.1 sk
02/26/15 Modified the code for MISRA-C:2012 compliance. </pre>

FILES:
XilinxProcessorIPLib/drivers/scuwdt/src/xscuwdt_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt_selftest.c @addtogroup
scuwdt_v2_1 @{ Contains diagnostic self-test functions for the XScuWdt driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a sdm
01/15/10 First release 2.1 sk 02/26/15 Modified the code for MISRA-C:2012
compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scuwdt/src/xscuwdt_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xscuwdt_sinit.c @addtogroup
scuwdt_v2_1 @{ This file contains method for static initialization (compile-
time) of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a sdm 01/15/10 First release 2.1 sk 02/26/15 Modified the code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/scuwdt/src/xscuwdt_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. \mainpage SD-FEC standalone driver
software API summary \section sec_init Initialization and Configuration The
XSdFec_Config structure is used by the driver to configure the FEC mode and
interface parameters defined for each SD-FEC device. The configuration structure
is created by the tool-chain based on HW build properties. To support multiple
runtime loading and initialization strategies employed by various operating
systems, the driver instance can be initialized in one of two ways: -
XSdFecInitialize(InstancePtr, DeviceId) - The driver looks up its own
configuration structure created by the tool-chain based on an ID provided by the
tool-chain. - XSdFecCfgInitialize(InstancePtr, CfgPtr) - Uses a configuration
structure provided by the caller. \section sec_data Data Structures One or more
device specific headers are produced during the generation of the board support
package, defining further device specific configuration parameters: - When the
device is configured for Turbo Decode, the header x<ipinst_name>_turbo_params.h,
contains an XSdFecturbo_parameters structure which is populated to match the
corresponding IP GUI configuration. - When the device is configured for LDPC a
header is generated per LDPC code specified on the corresponding IP GUI;
x<ipinst_name >_<code_id>_params.h. Each header defines an XSdFecldpc_parameters
structure populated with the configuration data required for the corresponding
LDPC code. \section sec_api API The driver provides the following functions: -
XSdFecSetTurboParams(InstancePtr, ParamsPtr) - Set Turbo parameters on a device
- XSdFecadd_ldpc_params(InstancePtr, CodeId, SCOffset, LAOffset, QCOffset,
ParamsPtr) - Add LDPC parameters to a device - XSdFecShareTableSize(ParamsPtr,
SCSizePtr, LASizePtr, QCSizePtr) - Calculate share table size for a LDPC code -
XSdFecInterruptClassifier(InstancePtr) - Classify interrupts In addition, the
driver provides set and get functions for all the individual registers defined
for the SD-FEC. \section sec_ex Example The processor based example design
output by the SD-FEC IP instance also includes an example application
demonstrating a basic use case of the software driver. /

FILES:
XilinxProcessorIPLib/drivers/sd_fec/src/xsdfec.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CORE_AXI_WR_PROTECT register /

FILES:
XilinxProcessorIPLib/drivers/sd_fec/src/xsdfec_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History ver who Date
Changes ----- ---- -------- 1.0 jsr 07/17/17 Created 1.1 jsr 10/05/18 Moved 3GB
specific video modes timing parameters from video common library to SDI common
driver

FILES:
XilinxProcessorIPLib/drivers/sdi_common/data/sdi_common.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdivid.c @addtogroup
sdi_common_v1_0 @{ Contains common utility variables that are used by SDI IP
drivers and applications. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 jsr 07/17/17 Initial release. 1.1 jsr 10/08/18
Removed redundant declarations Added SDI specific timing modes </pre>

FILES:
XilinxProcessorIPLib/drivers/sdi_common/src/xv_sdivid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdivid.h @addtogroup
sdi_common_v1_0 @{ @details Contains common utility functions that are typically
used by SDI IP drivers and applications. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 jsr 07/17/17 Initial release. 1.1
jsr 10/05/18 Moved 3GB specific video modes timing parameters from video common
library to SDI common driver </pre>

FILES:
XilinxProcessorIPLib/drivers/sdi_common/src/xv_sdivid.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdiaud_selftest_example.c
This file contains a example for using the SdiAud hardware device and SdiAud
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.0
kar 02/16/18 First release 1.1 kar 04/25/18 Changed default value of the clk
phase bit to 1. Removed version register macro. Removed get version API call
from the self test. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdiaud/examples/xsdiaud_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdiaud.c @addtogroup
sdiaud_v2_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 02/14/18 Initial release. 1.1 kar 04/25/18 Changed Set Clk
Phase API's 2nd argument description. 2.0 vve 09/27/18 Add 32 channel support
Add support for channel status extraction logic both on embed and extract side.
Add APIs to detect group change, sample rate change, active channel change
</pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdiaud/src/xsdiaud.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdiaud.h @addtogroup
sdiaud_v2_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 02/15/18 Initial release. 1.1 kar 04/25/18 Added new line
standards. Added new API to enable rate control. Removed inline function which
reads the IP version. 2.0 vve 09/27/18 Add 32 channel support Add support for
channel status extraction logic both on embed and extract side. Add APIs to
detect group change, sample rate change, active channel change </pre> /

FILES:
XilinxProcessorIPLib/drivers/sdiaud/src/xsdiaud.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

CAUTION: This file is automatically generated by HSI. Version: 2018.3.0 DO NOT
EDIT. All Rights Reserved. Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated documentation files (the
Software), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED AS IS,
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: Driver configuration

FILES:
XilinxProcessorIPLib/drivers/sdiaud/src/xsdiaud_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdiaud_hw.h @addtogroup
sdiaud_v2_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 02/14/18 Initial release. 1.1 kar 04/25/18 Removed version
register offset. Added rate control enable shift and mask. 2.0 vve 09/27/18 Add
32 channel support Add support for channel status extraction logic both on embed
and extract side. Add APIs to detect group change, sample rate change, active
channel change </pre> /

FILES:
XilinxProcessorIPLib/drivers/sdiaud/src/xsdiaud_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdiaud_intr.c @addtogroup
sdiaud_v2_0 @{ ... <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
---------- 1.0 kar 02/14/18 Initial release. 2.0 vve 09/27/18 Add 32 channel
support Add support for channel status extraction logic both on embed and
extract side. Add APIs to detect group change, sample rate change, active
channel change </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdiaud/src/xsdiaud_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdiaud_selftest.c
@addtogroup sdiaud_v2_0 @{ Contains an basic self-test API @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- ---------- 1.0 kar
02/14/18 Initial release. 1.1 kar 04/02/18 Added new macros for UHD-SDI standard
and channels. 2.0 vve 09/27/18 Add 32 channel support Add support for channel
status extraction logic both on embed and extract side. Add APIs to detect group
change, sample rate change, active channel change </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdiaud/src/xsdiaud_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdiaud_sinit.c @addtogroup
sdiaud_v2_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 02/14/18 Initial release. 2.0 vve 09/27/18 Add 32 channel
support Add support for channel status extraction logic both on embed and
extract side. Add APIs to detect group change, sample rate change, active
channel change </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdiaud/src/xsdiaud_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a hk 10/17/13 First release 2.0 adk 12/10/13
Updated as per the New Tcl API's 2.4 sk 12/04/14 Added CD and WP parameters 3.0
sk 07/16/16 Added BUS WIDTH, MIO BANK and HAS EMIO parameters. 3.3 mn 08/17/17
Enabled CCI support for A53 by adding cache coherency information. 3.6 mn
07/06/18 Generate canonical entry for IS_CACHE_COHERENT 3.8 mus 07/30/19 Added
CCI support for Versal at EL1 NS uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/sdps/data/sdps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsdps.c @addtogroup sdps_v3_8
@{ Contains the interface functions of the XSdPs driver. See xsdps.h for a
detailed description of the device and driver. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.00a hk/sg 10/17/13 Initial release 2.0 hk
12/13/13 Added check for arm to use sleep.h and its API's 2.1 hk 04/18/14 Add
sleep for microblaze designs. CR 781117. 2.2 hk 07/28/14 Make changes to enable
use of data cache. 2.3 sk 09/23/14 Send command for relative card address when
re-initialization is done.CR 819614. Use XSdPs_Change_ClkFreq API whenever
changing clock.CR 816586. 2.4 sk 12/04/14 Added support for micro SD without
WP/CD. CR 810655. Checked for DAT Inhibit mask instead of CMD Inhibit mask in
Cmd Transfer API. Added Support for SD Card v1.0 2.5 sg 07/09/15 Added SD 3.0
features kvn 07/15/15 Modified the code according to MISRAC-2012. 2.6 sk
10/12/15 Added support for SD card v1.0 CR 840601. 2.7 sk 11/24/15 Considered
the slot type befoe checking CD/WP pins. sk 12/10/15 Added support for MMC
cards. sk 02/16/16 Corrected the Tuning logic. sk 03/01/16 Removed Bus Width
check for eMMC. CR 938311. 2.8 sk 05/03/16 Standard Speed for SD to 19MHz in
ZynqMPSoC. CR951024 3.0 sk 06/09/16 Added support for mkfs to calculate sector
count. sk 07/16/16 Added support for UHS modes. sk 07/07/16 Used usleep API for
both arm and microblaze. sk 07/16/16 Added Tap delays accordingly to different
SD/eMMC operating modes. 3.1 mi 09/07/16 Removed compilation warnings with extra
compiler flags. sk 10/13/16 Reduced the delay during power cycle to 1ms as per
spec sk 10/19/16 Used emmc_hwreset pin to reset eMMC. sk 11/07/16 Enable Rst_n
bit in ext_csd reg if not enabled. 3.2 sk 11/30/16 Modified the voltage
switching sequence as per spec. sk 02/01/17 Added HSD and DDR mode support for
eMMC. vns 02/09/17 Added ARMA53_32 support for ZynqMP CR968397 sk 03/20/17 Add
support for EL1 non-secure mode. 3.3 mn 05/17/17 Add support for 64bit DMA
addressing mn 07/17/17 Add support for running SD at 200MHz mn 07/26/17 Fixed
compilation warnings mn 08/07/17 Modify driver to support 64-bit DMA in arm64
only mn 08/17/17 Added CCI support for A53 and disabled data cache operations
when it is enabled. mn 08/22/17 Updated for Word Access System support mn
09/06/17 Resolved compilation errors with IAR toolchain mn 09/26/17 Added
UHS_MODE_ENABLE macro to enable UHS mode 3.4 mn 10/17/17 Use different commands
for single and multi block transfers mn 03/02/18 Move UHS macro check to SD card
initialization routine 3.5 mn 04/18/18 Resolve compilation warnings for sdps
driver 3.6 mn 07/06/18 Fix Cppcheck and Doxygen warnings for sdps driver mn
08/01/18 Add support for using 64Bit DMA with 32-Bit Processor mn 08/01/18 Add
cache invalidation call before returning from ReadPolled API mn 08/14/18 Resolve
compilation warnings for ARMCC toolchain mn 10/01/18 Change Expected Response
for CMD3 to R1 for MMC mus 11/05/18 Support 64 bit DMA addresses for
Microblaze-X platform. 3.7 mn 02/01/19 Add support for idling of SDIO aru
03/12/19 Modified the code according to MISRAC-2012. 3.8 mn 04/12/19 Modified
TapDelay code for supporting ZynqMP and Versal </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdps/src/xsdps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsdps.h @addtogroup sdps_v3_8
@{ @details This file contains the implementation of XSdPs driver. This driver
is used initialize read from and write to the SD card. Features such as
switching bus width to 4-bit and switching to high speed, changing clock
frequency, block size etc. are supported. SD 2.0 uses 1/4 bus width and speeds
of 25/50KHz. Initialization, however is done using 1-bit bus width and 400KHz
clock frequency. SD commands are classified as broadcast and addressed. Commands
can be those with response only (using only command line) or response + data
(using command and data lines). Only one command can be sent at a time. During a
data transfer however, when dsta lines are in use, certain commands (which use
only the command line) can be sent, most often to obtain status. This driver
does not support multi card slots at present. Initialization: This includes
initialization on the host controller side to select clock frequency, bus power
and default transfer related parameters. The default voltage is 3.3V. On the SD
card side, the initialization and identification state diagram is implemented.
This resets the card, gives it a unique address/ID and identifies key card
related specifications. Data transfer: The SD card is put in transfer state to
read from or write to it. The default block size is 512 bytes and if supported,
default bus width is 4-bit and bus speed is High speed. The read and write
functions are implemented in polled mode using ADMA2. At any point, when key
parameters such as block size or clock/speed or bus width are modified, this
driver takes care of maintaining the same selection on host and card. All error
bits in host controller are monitored by the driver and in the event one of them
is set, driver will clear the interrupt status and communicate failure to the
upper layer. File system use: This driver can be used with xilffs library to
read and write files to SD. (Please refer to procedure in diskio.c). The file
system read/write example in polled mode can used for reference. There is no
example for using SD driver without file system at present. However, the driver
can be used without the file system. The glue layer in filesystem can be used as
reference for the same. The block count passed to the read/write function in one
call is limited by the ADMA2 descriptor table and hence care will have to be
taken to call read/write API's in a loop for large file sizes. Interrupt mode is
not supported because it offers no improvement when used with file system. eMMC
support: SD driver supports SD and eMMC based on the "enable MMC" parameter in
SDK. The features of eMMC supported by the driver will depend on those supported
by the host controller. The current driver supports read/write on eMMC card
using 4-bit and high speed mode currently. Features not supported include - card
write protect, password setting, lock/unlock, interrupts, SDMA mode, programmed
I/O mode and 64-bit addressed ADMA2, erase/pre-erase commands. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a hk/sg
10/17/13 Initial release 2.0 hk 03/07/14 Version number revised. 2.1 hk 04/18/14
Increase sleep for eMMC switch command. Add sleep for microblaze designs. CR
781117. 2.2 hk 07/28/14 Make changes to enable use of data cache. 2.3 sk
09/23/14 Send command for relative card address when re-initialization is
done.CR 819614. Use XSdPs_Change_ClkFreq API whenever changing clock.CR 816586.
2.4 sk 12/04/14 Added support for micro SD without WP/CD. CR 810655. Checked for
DAT Inhibit mask instead of CMD Inhibit mask in Cmd Transfer API. Added Support
for SD Card v1.0 2.5 sg 07/09/15 Added SD 3.0 features kvn 07/15/15 Modified the
code according to MISRAC-2012. 2.6 sk 10/12/15 Added support for SD card v1.0 CR
840601. 2.7 sk 11/24/15 Considered the slot type befoe checking CD/WP pins. sk
12/10/15 Added support for MMC cards. 01/08/16 Added workaround for issue in
auto tuning mode of SDR50, SDR104 and HS200. sk 02/16/16 Corrected the Tuning
logic. sk 03/01/16 Removed Bus Width check for eMMC. CR 938311. 2.8 sk 04/20/16
Added new workaround for auto tuning. 05/03/16 Standard Speed for SD to 19MHz in
ZynqMPSoC. CR951024 3.0 sk 06/09/16 Added support for mkfs to calculate sector
count. sk 07/16/16 Added support for UHS modes. sk 07/07/16 Used usleep API for
both arm and microblaze. sk 07/16/16 Added Tap delays accordingly to different
SD/eMMC operating modes. sk 08/13/16 Removed sleep.h from xsdps.h as a temporary
fix for CR956899. 3.1 mi 09/07/16 Removed compilation warnings with extra
compiler flags. sk 10/13/16 Reduced the delay during power cycle to 1ms as per
spec sk 10/19/16 Used emmc_hwreset pin to reset eMMC. sk 11/07/16 Enable Rst_n
bit in ext_csd reg if not enabled. sk 11/16/16 Issue DLL reset at 31 iteration
to load new zero value. 3.2 sk 11/30/16 Modified the voltage switching sequence
as per spec. sk 02/01/17 Added HSD and DDR mode support for eMMC. sk 02/01/17
Consider bus width parameter from design for switching vns 02/09/17 Added
ARMA53_32 support for ZynqMP CR968397 sk 03/20/17 Add support for EL1 non-secure
mode. 3.3 mn 05/17/17 Add support for 64bit DMA addressing mn 08/07/17 Modify
driver to support 64-bit DMA in arm64 only mn 08/17/17 Enabled CCI support for
A53 by adding cache coherency information. mn 09/06/17 Resolved compilation
errors with IAR toolchain 3.6 mn 08/01/18 Add support for using 64Bit DMA with
32-Bit Processor 3.7 mn 02/01/19 Add support for idling of SDIO 3.8 mn 04/12/19
Modified TapDelay code for supporting ZynqMP and Versal </pre>

FILES:
XilinxProcessorIPLib/drivers/sdps/src/xsdps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsdps_g.c @addtogroup sdps_v3_8
@{ This file contains a configuration table that specifies the configuration of
SD devices in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 1.00a hk/sg 10/17/13 Initial release 3.6 mn 07/06/18 Add
initialization macros in sdps mn 07/13/18 Add initializer macro for HasEMIO
</pre>

FILES:
XilinxProcessorIPLib/drivers/sdps/src/xsdps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsdps_hw.h @addtogroup
sdps_v3_8 @{ This header file contains the identifiers and basic HW access
driver functions (or macros) that can be used to access the device. Other driver
functions are defined in xsdps.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- --- -------- 1.00a hk/sg 10/17/13 Initial release 2.5 sg 07/09/15
Added SD 3.0 features kvn 07/15/15 Modified the code according to MISRAC-2012.
2.7 sk 12/10/15 Added support for MMC cards. sk 03/02/16 Configured the Tap
Delay values for eMMC HS200 mode. 2.8 sk 04/20/16 Added new workaround for auto
tuning. 3.0 sk 06/09/16 Added support for mkfs to calculate sector count. sk
07/16/16 Added support for UHS modes. sk 07/16/16 Added Tap delays accordingly
to different SD/eMMC operating modes. 3.1 sk 11/07/16 Enable Rst_n bit in
ext_csd reg if not enabled. 3.2 sk 03/20/17 Add support for EL1 non-secure mode.
3.3 mn 08/22/17 Updated for Word Access System support mn 09/06/17 Added support
for ARMCC toolchain 3.4 mn 01/22/18 Separated out SDR104 and HS200 clock defines
3.6 mn 07/06/18 Fix Doxygen warnings for sdps driver 3.8 mn 04/12/19 Modified
TapDelay code for supporting ZynqMP and Versal mn 05/21/19 Set correct tap
delays for Versal mn 05/21/19 Disable DLL Reset code for Versal mn 05/21/19
Enable SD UHS Mode support by default for Versal mn 07/03/19 Update Input Tap
Delays for Versal </pre>

FILES:
XilinxProcessorIPLib/drivers/sdps/src/xsdps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsdps_options.c @addtogroup
sdps_v3_8 @{ Contains API's for changing the various options in host and card.
See xsdps.h for a detailed description of the device and driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00a hk/sg
10/17/13 Initial release 2.1 hk 04/18/14 Increase sleep for eMMC switch command.
Add sleep for microblaze designs. CR 781117. 2.3 sk 09/23/14 Use
XSdPs_Change_ClkFreq API whenever changing clock.CR 816586. 2.5 sg 07/09/15
Added SD 3.0 features kvn 07/15/15 Modified the code according to MISRAC-2012.
2.7 sk 01/08/16 Added workaround for issue in auto tuning mode of SDR50, SDR104
and HS200. sk 02/16/16 Corrected the Tuning logic. sk 03/02/16 Configured the
Tap Delay values for eMMC HS200 mode. 2.8 sk 04/20/16 Added new workaround for
auto tuning. 3.0 sk 07/07/16 Used usleep API for both arm and microblaze. sk
07/16/16 Added support for UHS modes. sk 07/16/16 Added Tap delays accordingly
to different SD/eMMC operating modes. 3.1 mi 09/07/16 Removed compilation
warnings with extra compiler flags. sk 11/07/16 Enable Rst_n bit in ext_csd reg
if not enabled. sk 11/16/16 Issue DLL reset at 31 iteration to load new zero
value. 3.2 sk 02/01/17 Added HSD and DDR mode support for eMMC. sk 02/01/17
Consider bus width parameter from design for switching vns 02/09/17 Added
ARMA53_32 support for ZynqMP CR968397 vns 03/13/17 Fixed MISRAC mandatory
violation sk 03/20/17 Add support for EL1 non-secure mode. 3.3 mn 07/25/17
Removed SD0_OTAPDLYENA and SD1_OTAPDLYENA bits mn 08/07/17 Properly set OTAPDLY
value by clearing previous bit settings mn 08/17/17 Added CCI support for A53
and disabled data cache operations when it is enabled. mn 08/22/17 Updated for
Word Access System support 3.4 mn 01/22/18 Separated out SDR104 and HS200 clock
defines 3.6 mn 07/06/18 Fix Cppcheck warnings for sdps driver 3.7 aru 03/12/19
Modified the code according to MISRAC-2012. mn 03/27/19 Disable calls to
dll_reset API for versal SPP Platforms 3.8 mn 04/12/19 Modified TapDelay code
for supporting ZynqMP and Versal mn 05/21/19 Set correct tap delays for Versal
mn 05/21/19 Disable DLL Reset code for Versal </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdps/src/xsdps_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsdps_sinit.c @addtogroup
sdps_v3_8 @{ The implementation of the XSdPs component's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
-------- 1.00a hk/sg 10/17/13 Initial release kvn 07/15/15 Modified the code
according to MISRAC-2012. 3.7 aru 03/12/19 Modified the code according to
MISRAC-2012. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sdps/src/xsdps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"),to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_header.h @addtogroup
spdif @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 kar 01/25/18 First release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/spdif/data/xspdif_header.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspsdif_intr_example.c This
file contains a example for using the XSpdif hardware device and XSpdif driver
using interrupt mode.This example assumes that the interrupt controller is also
present as a part of the system. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.0 kar 01/25/18 First release </pre> / Include Files
/

FILES:
XilinxProcessorIPLib/drivers/spdif/examples/xspdif_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_selftest_example.c
This file contains a example for using the SPDIF hardware device and SPDIF
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.0
kar 01/25/18 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/spdif/examples/xspdif_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif.c @addtogroup
spdif_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif.h @addtogroup
xspdif_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_chsts.c @addtogroup
Spdif_v1_0 @{ This file implements the channel status format related
functions.For formats/line protocols check the AES Standard specifications
document. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 kar 01/25/18 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif_chsts.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_chsts.h @addtogroup
spdif_v1_0 @{ Format status related offsets & masks definitions related to the
channel status format. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 kar 01/25/18 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif_chsts.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_hw.h @addtogroup
spdif_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_intr.c @addtogroup
spdif_v1_0 @{ ... <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
---------- 1.0 kar 01/25/18 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_selftest.c @addtogroup
xspdif_v1_0 @{ Contains an basic self-test API @note None <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ----- ---------- 1.0 kar 01/25/18 Initial
release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xspdif_sinit.c @addtogroup
spdif_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 kar 01/25/18 Initial release. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/spdif/src/xspdif_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 10/12/13 Removed support for xps_spi
xps_insystem_flash @BEGIN_CHANGELOG EDK_M 11/27/09 ktn Removed support for
opb_spi @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3 06/16/10 sv Added support for
axi_spi @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/spi/data/spi.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 3.03a sdm 08/11/10 Added C_SPI_MODE parameter to
config structure 3.04a bss 03/21/12 Added C_TYPE_OF_AXI4_INTERFACE,
C_AXI4_BASEADDR and C_XIP_MODE to config structure. Modified such that based on
C_XIP_MODE and C_TYPE_OF_AXI4_INTERFACE parameters C_BASEADDR will be updated
with the value of C_AXI4_BASEADDR. Modified such that C_FIFO_EXIST will be
updated based on C_FIFO_DEPTH for compatibility of driver 3.06a adk 07/08/13
Added C_USE_STARTUP parameter to the config structure 4.0 adk 12/10/13 Updated
as per the New Tcl API's 4.2 sk 11/09/15 Removed delete filename statement CR
784758. 4.3 ms 04/18/17 Modified tcl file to add suffix U for all macros
definitions of spi in xparameters.h uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/spi/data/spi.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 4.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_L_SP4 - Removed the checking of the parametr
C_INTERRUPT_PRESENT as this is not present in the core @END_CHANGELOG
@BEGIN_CHANGELOG EDK_Im_SP2 - Added Interrupt support @END_CHANGELOG
@BEGIN_CHANGELOG EDK_I - include header files @END_CHANGELOG @BEGIN_CHANGELOG
EDK_H - Added support for generation of multiple applications. All TCL
procedures are now required to have a software project type as its first
argument @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/spi/data/spi_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_atmel_flash_example.c This
file contains a design example using the SPI driver (XSpi) and hardware device
with an Atmel Serial Flash Device (AT45XX series). This example erases the Page,
writes to the Page, reads back from the Page and compares the data. This example
works for an Atmel AT45DB161D. The bytes per page (ATMEL_PAGE_SIZE) in this
device is 528 bytes for default addressing mode and 512 bytes in Power-of-2
addressing mode. For further details of device refer to the Atmel Datasheet of
AT45DB161D device. The ATMEL_PAGE_SIZE constant need to be updated by the user
according to the Device used. The ATMEL_FLASH_TEST_ADDRESS constant need to be
updated by the user according to the serial flash device used, there is no error
checking done in the example for the address specified by the user. This example
also works with the In-System Flash(ISF) in the S3AN devices. The
ATMEL_PAGE_SIZE and ATMEL_FLASH_TEST_ADDRESS need to be defined properly based
on the device used. For further details of the ISF refer to the Spartan-3AN FPGA
In-System Flash User Guide (UG333). This example assumes that the underlying
processor is MicroBlaze and default addressing mode is used in the Flash Device.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sdn 02/26/08 First release 1.00a sdn 07/02/08 Changed the initialization
so that the SPI Master works in Spi Mode 3 as the In-System Flash works only in
Spi Mode 3 3.00a ktn 10/22/09 Converted all register accesses to 32 bit access.
Updated to use the HAL APIs/macros. Replaced call to XSpi_Initialize API with
XSpi_LookupConfig and XSpi_CfgInitialize. 4.2 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Modified Comment lines to follow doxygen rules. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_atmel_flash_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_eeprom_example.c This file
contains a design example using the SPI driver (XSpi) and hardware device with a
serial EEPROM device. The hardware which this example runs on must have a serial
EEPROM (Microchip 25XX320 or 25XX160) for it to run. This example has been
tested with the SPI EEPROM on the ML410 platform for PPC processor. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
02/27/01 First release 1.00c jhl 08/15/03 Fixed bugs (local instances and large
buffers are now moved to globals) 1.11a sv 9/10/07 Minor changes to comply to
Doxygen and coding guidelines 3.00a ktn 10/28/09 Converted all register accesses
to 32 bit access. Updated to use the HAL APIs/macros. Replaced call to
XSpi_Initialize API with XSpi_LookupConfig and XSpi_CfgInitialize. 4.2 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 04/05/17 Modified Comment lines to follow doxygen rules.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_eeprom_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_intel_flash_example.c This
file contains a design example using the SPI driver (XSpi) and hardware device
with an Intel Serial Flash Memory (S33) in the interrupt mode. This example
erases a sector, writes to a Page within the sector, reads back from that Page
and compares the data. The example works with an Intel Serial Flash Memory
(S33). The number of bytes per page in this device is 256. For further details
about the device refer to the Intel Serial Flash Memory (S33) Data sheet This
example assumes that the underlying processor is MicroBlaze. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sd 02/26/08
First release 3.00a ktn 10/22/09 Converted all register accesses to 32 bit
access. Updated to use the HAL APIs/macros. Replaced call to XSpi_Initialize API
with XSpi_LookupConfig and XSpi_CfgInitialize. 4.2 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Modified Comment lines to follow doxygen rules. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_intel_flash_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_intr_example.c This file
contains a design example using the Spi driver (XSpi) and the Spi device using
the interrupt mode. This example works with a PPC/MicroBlaze processor. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a
sv 05/29/06 First release for Test App Integration for Interrupt examples 1.11a
sdm 03/03/08 Minor changes to comply to Doxygen and coding guidelines 3.00a ktn
10/22/09 Converted all register accesses to 32 bit access. Updated to use the
HAL APIs/macros. Replaced call to XSpi_Initialize API with XSpi_LookupConfig and
XSpi_CfgInitialize. 3.02a sdm 05/04/11 Updated to run the loopback test only in
standard spi mode. 4.2 ms 01/23/17 Added xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. 4.5 akm 07/12/19 Fixed compilation error
by passing the correct interrupt controller instance to SpiIntrExample()
function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_low_level_example.c This
file contains a design example using the low-level driver of the SPI driver
(XSpi). These macros are found in xspi_l.h. A simple loopback test is done
within an SPI device in polled mode. This example works only with 8-bit wide
data transfers. @note This example works only with 8-bit wide data transfers in
standard SPI mode. This example will not work if the axi_qspi device is
confiured in dual/quad modes. To make this example work for 16 bit transfers
change u8 Buffer[BUFFER_SIZE] to u16 Buffer[BUFFER_SIZE]. The SPI Core should
also be configured for 16 bit access during the build time. To make this example
work for 32 bit transfers change u8 Buffer[BUFFER_SIZE] to u32
Buffer[BUFFER_SIZE]. The SPI Core should also be configured for 32 bit access
during the build time. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00b rpm 04/24/02 First release 1.00b jhl 09/10/02 Added code to
ensure it works with a fast processor. 1.00b sv 05/16/05 Minor changes to comply
to Doxygen and coding guidelines 3.00a ktn 10/28/09 Converted all register
accesses to 32 bit access. 3.02a sdm 05/04/11 Added a note about dual/quad modes
in axi_qspi. 4.2 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xspi_numonyx_flash_quad_example.c This file contains a design example using the
SPI driver (XSpi) and axi_qspi device with a Numonyx quad serial flash device in
the interrupt mode. This example erases a Sector, writes to a Page within the
Sector, reads back from that Page and compares the data. This example has been
tested with an N25Q128 device on KC705 and ZC770 board. The bytes per page
(PAGE_SIZE) in N25Q128 is 256. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a bss 08/08/12 First release 3.04a bss
02/11/13 Modified to use ScuGic in case of Zynq (CR683510) 4.2 ms 01/23/17 Added
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Modified Comment lines to follow doxygen rules. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_numonyx_flash_quad_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_polled_example.c This file
contains a design example using the Spi driver (XSpi) and the Spi device using
the polled mode. To put the driver in polled mode the Global Interrupt must be
disabled after the Spi is Initialized and Spi driver is started. This example
works with a PPC/MicroBlaze processor. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a sdm 03/03/08 First Release 3.00a
ktn 10/28/09 Converted all register accesses to 32 bit access. Updated to use
the HAL APIs/macros. Replaced call to XSpi_Initialize API with XSpi_LookupConfig
and XSpi_CfgInitialize. 3.02a sdm 05/04/11 Updated to run the loopback test only
in standard spi mode. 4.2 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_selftest_example.c This
file contains a example for using the SPI Hardware and driver. @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sv 05/16/05
Initial release for TestApp integration. 1.11a sdm 03/03/08 Minor changes to
comply to coding guidelines 3.00a ktn 10/28/09 Converted all register accesses
to 32 bit access. Updated to use the HAL APIs/macros. Replaced call to
XSpi_Initialize API with XSpi_LookupConfig and XSpi_CfgInitialize. 4.2 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_slave_intr_example.c This
file contains a design example using the Spi driver (XSpi) and the Spi device as
a Slave, in interrupt mode. This example fills the Spi Tx buffer with the number
of data bytes it expects to receive from the master and then Spi device waits
for an external master to initiate the transfer. When the master initiates the
transfer, the Spi device receives data from the master and simultaneously sends
the data in Tx buffer to the master. Once the transfer is complete, a transfer
complete interrupt is generated and this example prints the data received from
the master. The number of bytes to be received by the Spi slave is defined by
the constant BUFFER_SIZE in this file. The external SPI devices that are present
on the Xilinx boards don't support the Master functionality. This example has
been tested with Aardvark I2C/SPI Host Adapter, an off board external SPI Master
device and the Xilinx SPI device configured as a Slave. This example has been
tested for byte-wide SPI transfers. @note This example assumes that there is a
STDIO device in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a psk 09/05/08 First Release 3.00a ktn 10/22/09
Converted all register accesses to 32 bit access. Updated to use the HAL
APIs/macros. Replaced call to XSpi_Initialize API with XSpi_LookupConfig and
XSpi_CfgInitialize. 3.01a sdm 04/23/10 Enabled DTR Half_empty interrupt so that
Tx FIFO is not empty during a transfer in slave mode. 4.2 ms 01/23/17 Added
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_slave_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_slave_polled_example.c
This file contains a design example using the Spi driver (XSpi) and the SPI
device as a Slave, in polled mode. This example fills the Spi Tx buffer with the
number of data bytes it expects to receive from the master and then Spi device
waits for an external master to initiate the transfer. When the master initiates
the transfer, the Spi device receives data from the master and simultaneously
sends the data in Tx buffer to the master. Once the transfer is complete, this
example prints the data received from the master. The number of bytes to be
received by the Spi slave is defined by the constant BUFFER_SIZE in this file.
The external SPI devices that are present on the Xilinx boards don't support the
Master functionality. This example has been tested with an off board external
SPI Master device and the Xilinx SPI device configured as a Slave. This example
has been tested for byte-wide SPI transfers. @note This example assumes that
there is a STDIO device in the system. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a psk 09/05/08 First Release 3.00a ktn 10/28/09
Converted all register accesses to 32 bit access. Updated to use the HAL
APIs/macros. Replaced call to XSpi_Initialize API with XSpi_LookupConfig and
XSpi_CfgInitialize. 4.2 ms 01/23/17 Added xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_slave_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_stm_flash_example.c This
file contains a design example using the SPI driver (XSpi) and hardware device
with an STM serial Flash device (M25P series) in the interrupt mode. This
example erases a Sector, writes to a Page within the Sector, reads back from
that Page and compares the data. This example has been tested with an M25P16
device. The bytes per page (STM_PAGE_SIZE) in M25P16 is 256. This example
assumes that the underlying processor is MicroBlaze. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sd 02/26/08
First release 3.00a ktn 10/28/09 Converted all register accesses to 32 bit
access. Updated to use the HAL APIs/macros. Replaced call to XSpi_Initialize API
with XSpi_LookupConfig and XSpi_CfgInitialize. 4.2 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 04/05/17
Modified Comment lines to follow doxygen rules. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_stm_flash_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xspi_winbond_flash_quad_example.c This file contains a design example using the
SPI driver (XSpi) and axi_qspi device with a Winbond quad serial flash device in
the interrupt mode. This example erases a Sector, writes to a Page within the
Sector, reads back from that Page and compares the data. This example has been
tested with an W25Q64 device. The bytes per page (PAGE_SIZE) in W25Q64 is 256.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sdm 04/01/11 First release 4.2 ms 01/23/17 Added xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. ms 04/05/17 Modified
Comment lines to follow doxygen rules. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_winbond_flash_quad_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xspi_winbond_flash_xip_example.c This file contains a design example using the
Spi driver (XSpi) and the Spi device configured in XIP Mode. This example reads
data from the Flash Memory in the way RAM is accessed. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 3.04a bss
03/21/12 First Release 4.2 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. ms 04/10/17 Modified filename tag to
include the file in doxygen examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/examples/xspi_winbond_flash_xip_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi.c @addtogroup spi_v4_5 @{
Contains required functions of the XSpi driver component. See xspi.h for a
detailed description of the device and driver. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a rpm 10/11/01 First release 1.00b jhl
03/14/02 Repartitioned driver for smaller files. 1.00b rpm 04/25/02 Collapsed
IPIF and reg base addresses into one 1.00b rmm 05/14/03 Fixed diab compiler
warnings relating to asserts 1.01a jvb 12/13/05 Changed Initialize() into
CfgInitialize(), and made CfgInitialize() take a pointer to a config structure
instead of a device id. Moved Initialize() into xspi_sinit.c, and had
Initialize() call CfgInitialize() after it retrieved the config structure using
the device id. Removed include of xparameters.h along with any dependencies on
xparameters.h and the _g.c config table. 1.11a wgr 03/22/07 Converted to new
coding style. 1.11a rpm 01/22/08 Updated comment on Transfer regarding needing
interrupts. 1.12a sdm 03/27/08 Updated the code to support 16/32 bit transfer
width and polled mode of operation. Even for the polled mode of operation the
Interrupt Logic in the core should be included. The driver can be put in polled
mode of operation by disabling the Global Interrupt after the Spi Initialization
is completed. 2.00a sdm 07/30/08 Updated the code to support 16/32 bit transfer
width and polled mode of operation. Even for the polled mode of operation the
Interrupt Logic in the core should be included. The driver can be put in polled
mode of operation by disabling the Global Interrupt after the Spi Initialization
is completed. 2.01b sdm 04/08/09 Fixed an issue in the XSpi_Transfer function
where the Global Interrupt is being enabled in polled mode when a slave is not
selected. 3.00a ktn 10/28/09 Updated all the register accesses as 32 bit access.
Updated to use the HAL APIs/macros. Removed the macro XSpi_mReset, XSpi_Reset
API should be used in its place. The macros have been renamed to remove _m from
the name. Removed an unnecessary read to the core register in the
XSpi_GetSlaveSelect API. 3.01a sdm 04/23/10 Updated the driver to handle new
slave mode interrupts and the DTR Half Empty interrupt. 3.04a bss 03/21/12
Updated XSpi_CfgInitialize to support XIP Mode 3.05a adk 18/04/13 Updated the
code to avoid unused variable warnings when compiling with the -Wextra -Wall
flags In the file xspi.c. CR:705005. 3.06a adk 07/08/13 Added a dummy read in
the CfgInitialize(), if startup block is used in the h/w design (CR 721229).
3.07a adk 11/10/13 In the xspi_transfer function moved the assert slave chip
select after the configuration of the Data Transmit register inorder to work
with CPOL and CPHA High Options. As per spec (Dual/Quad SPI Transaction
instrunction 7,8,9) CR:732962 4.1 bss 08/07/14 Modified XSpi_Transfer to check
for Interrupt Status register Tx Empty bit instead of Status register CR810294.
4.2 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed
the prototype of XSpi_CfgInitialize API. 4.4 tjs 11/28/17 When receive fifo
exists, we need to check for status register rx fifo empty flag. If clear we can
proceed for read. Otherwise we will hit exception. CR 989938 4.5 akm 05/29/19
Removed master inhibit dependency while writing DTR in between multiple
transfers. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi.h @addtogroup spi_v4_5 @{
@details This component contains the implementation of the XSpi component. It is
the driver for an SPI master or slave device. It supports 8-bit, 16-bit and
32-bit wide data transfers. SPI is a 4-wire serial interface. It is a full-
duplex, synchronous bus that facilitates communication between one master and
one slave. The device is always full-duplex, which means that for every byte
sent, one is received, and vice-versa. The master controls the clock, so it can
regulate when it wants to send or receive data. The slave is under control of
the master, it must respond quickly since it has no control of the clock and
must send/receive data as fast or as slow as the master does. The application
software between master and slave must implement a higher layer protocol so that
slaves know what to transmit to the master and when. <b>Initialization &
Configuration</b> The XSpi_Config structure is used by the driver to configure
itself. This configuration structure is typically created by the tool-chain
based on HW build properties. To support multiple runtime loading and
initialization strategies employed by various operating systems, the driver
instance can be initialized in one of the following ways: -
XSpi_Initialize(InstancePtr, DeviceId) - The driver looks up its own
configuration structure created by the tool-chain based on an ID provided by the
tool-chain. - XSpi_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) - Uses a
configuration structure provided by the caller. If running in a system with
address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <b>Multiple Masters</b>
More than one master can exist, but arbitration is the responsibility of the
higher layer software. The device driver does not perform any type of
arbitration. <b>Multiple Slaves</b> Multiple slaves are supported by adding
additional slave select (SS) signals to each device, one for each slave on the
bus. The driver ensures that only one slave can be selected at any one time.
<b>FIFOs</b> The SPI hardware is parameterized such that it can be built with or
without FIFOs. When using FIFOs, both send and receive must have FIFOs. The
driver will not function correctly if one direction has a FIFO but the other
direction does not. The frequency of the interrupts which occur is proportional
to the data rate such that high data rates without the FIFOs could cause the
software to consume large amounts of processing time. The driver is designed to
work with or without the FIFOs. <b>Interrupts</b> The user must connect the
interrupt handler of the driver, XSpi_InterruptHandler to an interrupt system
such that it will be called when an interrupt occurs. This function does not
save and restore the processor context such that the user must provide this
processing. The driver handles the following interrupts: - Data Transmit
Register/FIFO Empty - Data Transmit FIFO Half Empty - Data Transmit
Register/FIFO Underrun - Data Receive Register/FIFO Overrun - Mode Fault Error -
Slave Mode Fault Error - Slave Mode Select - Data Receive FIFO not Empty The
Data Transmit Register/FIFO Empty interrupt indicates that the SPI device has
transmitted all the data available to transmit, and now its data register (or
FIFO) is empty. The driver uses this interrupt to indicate progress while
sending data. The driver may have more data to send, in which case the data
transmit register (or FIFO) is filled for subsequent transmission. When this
interrupt arrives and all the data has been sent, the driver invokes the status
callback with a value of XST_SPI_TRANSFER_DONE to inform the upper layer
software that all data has been sent. The Data Transmit FIFO Half Empty
interrupt indicates that the SPI device has transmitted half of the data
available, in the FIFO, to transmit. The driver uses this interrupt to indicate
progress while sending data. The driver may have more data to send, in which
case the data transmit FIFO is filled for subsequent transmission. This
interrupt is particualrly useful in slave mode, while transferring more than
FIFO_DEPTH number of bytes. In this case, the driver ensures that the FIFO is
never empty during a transfer and avoids master receiving invalid data. The Data
Transmit Register/FIFO Underrun interrupt indicates that, as slave, the SPI
device was required to transmit but there was no data available to transmit in
the transmit register (or FIFO). This may not be an error if the master is not
expecting data, but in the case where the master is expecting data this serves
as a notification of such a condition. The driver reports this condition to the
upper layer software through the status handler. The Data Receive Register/FIFO
Overrun interrupt indicates that the SPI device received data and subsequently
dropped the data because the data receive register (or FIFO) was full. The
interrupt applies to both master and slave operation. The driver reports this
condition to the upper layer software through the status handler. This likely
indicates a problem with the higher layer protocol, or a problem with the slave
performance. The Mode Fault Error interrupt indicates that while configured as a
master, the device was selected as a slave by another master. This can be used
by the application for arbitration in a multimaster environment or to indicate a
problem with arbitration. When this interrupt occurs, the driver invokes the
status callback with a status value of XST_SPI_MODE_FAULT. It is up to the
application to resolve the conflict. The Slave Mode Fault Error interrupt
indicates that a slave device was selected as a slave by a master, but the slave
device was disabled. This can be used during system debugging or by the slave
application to learn when the slave application has not prepared for a master
operation in a timely fashion. This likely indicates a problem with the higher
layer protocol, or a problem with the slave performance. The Slave Mode Select
interrupt indicates that the SPI device was selected as a slave by a master. The
driver reports this condition to the upper layer software through the status
handler. Data Receive FIFO not Empty interrupt indicates that the SPI device, in
slave mode, has received a data byte in the Data Receive FIFO, after the master
has started a transfer. The driver reports this condition to the upper layer
software through the status handler. <b>Polled Operation</b> This driver
operates in polled mode operation too. To put the driver in polled mode the
Global Interrupt must be disabled after the Spi is Initialized and Spi driver is
started. Statistics are not updated in this mode of operation. <b>Device
Busy</b> Some operations are disallowed when the device is busy. The driver
tracks whether a device is busy. The device is considered busy when a data
transfer request is outstanding, and is considered not busy only when that
transfer completes (or is aborted with a mode fault error). This applies to both
master and slave devices. <b>Device Configuration</b> The device can be
configured in various ways during the FPGA implementation process. Configuration
parameters are stored in the xspi_g.c file or passed in via _CfgInitialize(). A
table is defined where each entry contains configuration information for an SPI
device. This information includes such things as the base address of the memory-
mapped device, the number of slave select bits in the device, and whether the
device has FIFOs and is configured as slave-only. <b>RTOS Independence</b> This
driver is intended to be RTOS and processor independent. It works with physical
addresses only. Any needs for dynamic memory management, threads or thread
mutual exclusion, virtual memory, or cache control must be satisfied by the
layer above this driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a rpm 10/11/01 First release 1.00b jhl 03/14/02 Repartitioned
driver for smaller files. 1.01a jvb 12/14/05 I separated dependency on the
static config table and xparameters.h from the driver initialization by moving
_Initialize and _LookupConfig to _sinit.c. I also added the new _CfgInitialize
routine. 1.11a wgr 03/22/07 Converted to new coding style. 1.11a sv 02/22/08
Added the definition of LSB-MSB first option in xspi_l.h. 1.12a sdm 03/22/08
Updated the code to support 16/32 bit transfer width and polled mode of
operation, removed the macros in xspi_l.h, added macros in xspi.h file, moved
the interrupt register/bit definitions from xspi_i.h to xpsi_l.h. Even for the
polled mode of operation the Interrupt Logic in the core should be included. The
driver can be put in polled mode of operation by disabling the Global Interrupt
after the Spi Initialization is completed and Spi is started. 2.00a sdm 07/30/08
Updated the code to support 16/32 bit transfer width and polled mode of
operation, removed the macros in xspi_l.h, added macros in xspi.h file, moved
the interrupt register/bit definitions from xspi_i.h to xpsi_l.h. Even for the
polled mode of operation the Interrupt Logic in the core should be included. The
driver can be put in polled mode of operation by disabling the Global Interrupt
after the Spi Initialization is completed and Spi is started. 2.01a sdm 08/22/08
Removed support for static interrupt handlers from the MDD file 2.01b sdm
04/08/09 Fixed an issue in the XSpi_Transfer function where the Global Interrupt
is being enabled in polled mode when a slave is not selected. 3.00a ktn 10/22/09
Converted all register accesses to 32 bit access. Updated driver to use the HAL
APIs/macros. Removed the macro XSpi_mReset, XSpi_Reset API should be used in its
place. The macros have been renamed to remove _m from the name
XSpi_mIntrGlobalEnable is renamed XSpi_IntrGlobalEnable, XSpi_mIntrGlobalDisable
is now XSpi_IntrGlobalDisable, XSpi_mIsIntrGlobalEnabled is now
XSpi_IsIntrGlobalEnabled, XSpi_mIntrGetStatus is now XSpi_IntrGetStatus,
XSpi_mIntrClear is now XSpi_IntrClear, XSpi_mIntrEnable is now XSpi_IntrEnable,
XSpi_mIntrDisable is now XSpi_IntrDisable, XSpi_mIntrGetEnabled is now
XSpi_IntrGetEnabled, XSpi_mSetControlReg is now XSpi_SetControlReg,
XSpi_mGetControlReg is now XSpi_GetControlReg, XSpi_mGetStatusReg is now
XSpi_GetStatusReg, XSpi_mSetSlaveSelectReg is now XSpi_SetSlaveSelectReg,
XSpi_mGetSlaveSelectReg is now XSpi_GetSlaveSelectReg, XSpi_mEnable is now
XSpi_Enable, XSpi_mDisable is now XSpi_Disable. 3.01a sdm 04/23/10 Updated the
driver to handle new slave mode interrupts and the DTR Half Empty interrupt.
3.02a sdm 03/30/11 Updated to support axi_qspi. 3.03a sdm 08/09/11 Updated the
selftest to check for a correct default value in the case of axi_qspi - CR
620502 Updated tcl to generate a config parameter for C_SPI_MODE 3.04a bss
03/21/12 Updated XSpi_Config and XSpi instance structure to support XIP Mode.
Updated XSpi_CfgInitialize to support XIP Mode Added XIP Mode Register masks in
xspi_l.h Tcl Script changes: Added C_TYPE_OF_AXI4_INTERFACE, C_AXI4_BASEADDR and
C_XIP_MODE to config structure. Modified such that based on C_XIP_MODE and
C_TYPE_OF_AXI4_INTERFACE parameters C_BASEADDR will be updated with
C_AXI4_BASEADDR. Modified such that C_FIFO_EXIST will be updated based on
C_FIFO_DEPTH for compatibility of the driver with Axi Spi. 3.05a adk 18/04/13
Updated the code to avoid unused variable warnings when compiling with the
-Wextra -Wall flags In the file xspi.c. CR:705005. 3.06a adk 07/08/13 Added a
dummy read in the CfgInitialize(), if startup block is used in the h/w design
(CR 721229). 3.07a adk 11/10/13 Fixed CR:732962 Changes are made in the xspi.c
file 4.0 adk 19/12/13 Updated as per the New Tcl API's 4.1 bss 08/07/14 Modified
XSpi_Transfer in xspi.c and LoopbackTest in xspi_selftest.c to check for
Interrupt Status register Tx Empty bit instead of Status register CR810294. 4.2
sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototype of XSpi_CfgInitialize API. ms 01/23/17 Added xil_printf statement in
main function for all examples to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. ms 04/05/17
Modified Comment lines in functions of spi examples to follow doxygen rules. 4.3
ms 04/18/17 Modified tcl file to add suffix U for all macros definitions of spi
in xparameters.h 4.4 tjs 11/28/17 When receive fifo exists, we need to check for
status register rx fifo empty flag. If clear we can proceed for read. Otherwise
we will hit exception. CR 989938 4.5 akm 05/29/19 Removed master inhibit
dependency while writing DTR in between multiple transfers. 4.5 akm 07/12/19
Fixed compilation error in spi interrupt example by passing the correct
interrupt controller instance to SpiIntrExample() function (CR-1035793). </pre>

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_g.c @addtogroup spi_v4_5
@{ This file contains a configuration table that specifies the configuration of
SPI devices in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a rpm 10/11/01 First release 1.00b jhl 03/14/02
Repartitioned driver for smaller files. 1.00b rpm 04/24/02 Condensed config
typedef - got rid of versions and multiple base addresses. 1.11a wgr 03/22/07
Converted to new coding style. 1.12a sv 03/17/08 Updated the code to support
16/32 bit transfer width. 2.00a sv 07/30/08 Updated the code to support 16/32
bit transfer width. 3.02a sdm 05/04/11 Added a new parameter for the mode in
which SPI device operates. 3.06a adk 07/08/13 Added a new parameter for the
startup block </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_i.h @addtogroup spi_v4_5
@{ This header file contains internal identifiers. It is intended for internal
use only. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a rpm 10/11/01 First release 1.00b jhl 03/14/02 Repartitioned driver for
smaller files. 1.00b rpm 04/24/02 Moved register definitions to xspi_l.h 1.11a
wgr 03/22/07 Converted to new coding style. 1.12a sv 03/28/08 Removed the Macro
for statistics, moved the interrupt register definitions and bit definitions to
_l.h. 2.00a sv 07/30/08 Removed the Macro for statistics, moved the interrupt
register definitions and bit definitions to _l.h. </pre>

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_l.h @addtogroup spi_v4_5
@{ This header file contains identifiers, Register Definitions and basic driver
functions (or macros) that can be used to access the device. Refer xspi.h for
information about the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00b rpm 04/24/02 First release 1.11a wgr 03/22/07
Converted to new coding style. 1.11a sv 02/22/08 Added the definition of LSB-MSB
first option. 1.12a sv 03/28/08 Removed macros in _l.h file, moved the interrupt
register definitions from _i.h to _l.h. 2.00a sv 07/30/08 Removed macros in _l.h
file, moved the interrupt register definitions from _i.h to _l.h. 3.00a ktn
10/28/09 Updated all the register accesses as 32 bit access. Added XSpi_ReadReg
and XSpi_WriteReg macros. 3.01a sdm 04/23/10 Added definitions for the new slave
mode interrupts. 3.02a sdm 03/30/11 Added definitions for the new register bits
in axi_qspi. 3.04a bss 03/21/12 Added XIP Mode Register masks </pre>

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_options.c @addtogroup
spi_v4_5 @{ Contains functions for the configuration of the XSpi driver
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00b jhl 2/27/02 First release 1.00b rpm 04/25/02 Collapsed IPIF and reg base
addresses into one 1.11a wgr 03/22/07 Converted to new coding style. 3.00a ktn
10/28/09 Updated all the register accesses as 32 bit access. Updated driver to
use the HAL APIs/macros. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_selftest.c @addtogroup
spi_v4_5 @{ This component contains the implementation of selftest functions for
the XSpi driver component. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00b jhl 2/27/02 First release 1.00b rpm 04/25/02 Collapsed
IPIF and reg base addresses into one 1.11a wgr 03/22/07 Converted to new coding
style. 1.12a sv 03/17/08 Updated the code to support 16/32 bit transfer width.
2.00a sv 07/30/08 Updated the code to support 16/32 bit transfer width. 3.00a
sdm 10/28/09 Updated all the register accesses as 32 bit access. 3.02a sdm
05/04/11 Updated to run the loopback test only in standard spi mode. 3.03a sdm
08/09/11 Updated the selftest to check for a correct default value in the case
of axi_qspi - CR 620502 3.04a bss 03/21/12 Updated Selftest to check for XIP
mode and return if XIP mode is true </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_sinit.c @addtogroup
spi_v4_5 @{ The implementation of the XSpi component's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.01a jvb 10/13/05 First release 1.11a wgr 03/22/07 Converted to new
coding style. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi_stats.c @addtogroup
spi_v4_5 @{ This component contains the implementation of statistics functions
for the XSpi driver component. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00b jhl 03/14/02 First release 1.00b rpm 04/25/02 Changed
macro naming convention 1.11a wgr 03/22/07 Converted to new coding style. 1.12a
sv 03/28/08 Removed the call to the Macro for clearing statistics. 2.00a sv
07/30/08 Removed the call to the Macro for clearing statistics. 3.00a ktn
10/28/09 Updated all the register accesses as 32 bit access. Updated driver to
use the HAL APIs/macros. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spi/src/xspi_stats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_eeprom_intr_example.c
This file contains a design example using the SPI driver (XSpiPs) in interrupt
mode and hardware device with a serial EEPROM device. The hardware which this
example runs on must have a serial EEPROM (Microchip 25XX320 or 25XX160) for it
to run. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 sdm 02/27/10 First release 1.00 sdm 10/25/11 Updated the chip
select to be used to second chip select ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation and also
modified filename tag to include the file in doxygen examples. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/spips/examples/xspips_eeprom_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_eeprom_polled_example.c
This file contains a design example using the SPI driver (XSpiPs) in polled mode
and hardware device with a serial EEPROM device. The hardware which this example
runs on must have a serial EEPROM (Microchip 25XX320 or 25XX160) for it to run.
This example has been tested with the SPI EEPROM on the EP4.5 ARM processor.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00 sdm 03/09/10 First release 1.00 sdm 10/25/11 Updated the chip select to be
used to second chip select ms 04/05/17 Modified Comment lines in functions to
recognize it as documentation block for doxygen generation and also modified
filename tag to include the file in doxygen examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/examples/xspips_eeprom_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_flash_intr_example.c
This file contains a design example using the SPI driver (XSpiPs) in interrupt
mode with a serial flash device. This examples performs transfers in Manual
start mode using interrupts. The hardware which this example runs on, must have
a serial flash for it to run. This example has been tested with SST25W080. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00
sg 1/30/13 First release ms 04/05/17 Modified Comment lines in functions to
recognize it as documentation block for doxygen generation. 3.2 nsk 03/26/19 Add
support for versal </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/examples/xspips_flash_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_flash_polled_example.c
This file contains a design example using the SPI driver (XSpiPs) in polled mode
with a Serial Flash device. This examples performs transfers in polled mode. The
hardware which this example runs on, must have a Serial Flash for it to run.
This example has been tested with SST25W080. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.00 sg 1/30/13 First release
ms 04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation and also modified filename tag to include the file
in doxygen examples. 3.2 nsk 03/26/19 Add support for versal </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/spips/examples/xspips_flash_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_selftest_example.c This
file contains an example for using the SPI Hardware, it does a simple hardware
connection check. @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 drg/jz 01/25/10 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/examples/xspips_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_slave_polled_example.c
This file contains a design example using the SPI controller in slave mode. This
examples performs transfers in polled mode and has been tested with Aardvark
Analyzer as Master. This example echoes data which it receives from the master.
The slave controller expects MAX_DATA bytes of data from the master to transmit
onto the SPI bus which the slave will receive into its Rx buffer. It will poll
until the Rx FIFO is filled with the Threshold limit of data which is set to
MAX_DATA. On sending data, the master will receive dummy bytes in response.
Master has to send MAX_DATA dummy bytes to read back the echoed data. @note The
slave mode test needs an external master to send data to the Spi device. This
example has been tested with Aardvark Analyzer as Master. The Clock Polarity and
Phase should match between master and the slave. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 2.0 sb 08/22/14 First release ms 04/05/17
Modified Comment lines in functions to recognize it as documentation block for
doxygen generation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/examples/xspips_slave_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips.c @addtogroup spips_v3_3
@{ Contains implements the interface functions of the XSpiPs driver. See
xspips.h for a detailed description of the device and driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 drg/jz 01/25/10 First
release 1.01 sg 03/07/12 Updated the code to always clear the relevant bits
before writing to config register. Always clear the slave select bits before
write and clear the bits to no slave at the end of transfer Modified the Polled
transfer transmit/receive logic. Tx should wait on TXOW Interrupt and Rx on
RXNEMTY. 1.03 sg 09/21/12 Added memory barrier dmb in polled transfer and
interrupt handler to overcome the clock domain crossing issue in the controller.
For CR 679252. 1.04a sg 01/30/13 Changed SPI transfer logic for polled and
interrupt modes to be based on filled tx fifo count and receive based on it.
RXNEMPTY interrupt is not used. SetSlaveSelect API logic is modified to drive
the bit position low based on the slave select value requested. GetSlaveSelect
API will return the value based on bit position that is low. 1.06a hk 08/22/13
Changed GetSlaveSelect function. CR 727866. Added masking ConfigReg before
writing in SetSlaveSel Added extended slave select support - CR722569. Added
check for MODF in polled transfer function. 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. 3.02 raw 11/23/15 Updated XSpiPs_Abort() to read all
RXFIFO entries. This change is to tackle CR910231. 3.1 tjs 04/12/18 InputClockHz
parameter copied in instance for use in application. CR998910 3.1 tjs 11/23/18
Added a check for A72 and R5 processor to avoid changes made for the workaround
DT842463. 3.2 aru 01/20/19 Fixes violations according to MISRAC-2012 in safety
mode and done changes such as Declared the pointer param as Pointer to const,
added goto statements. 3.3 akm 08/06/19 Initialized DeviceID in
XSpiPs_CfgInitialize function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips.h @addtogroup spips_v3_3
@{ @details This file contains the implementation of the XSpiPs driver. It works
for both the master and slave mode. User documentation for the driver functions
is contained in this file in the form of comment blocks at the front of each
function. An SPI device connects to an SPI bus through a 4-wire serial
interface. The SPI bus is a full-duplex, synchronous bus that facilitates
communication between one master and one slave. The device is always full-
duplex, which means that for every byte sent, one is received, and vice-versa.
The master controls the clock, so it can regulate when it wants to send or
receive data. The slave is under control of the master, it must respond quickly
since it has no control of the clock and must send/receive data as fast or as
slow as the master does. <b>Initialization & Configuration</b> The XSpiPs_Config
structure is used by the driver to configure itself. This configuration
structure is typically created by the tool-chain based on HW build properties.
To support multiple runtime loading and initialization strategies employed by
various operating systems, the driver instance can be initialized in the
following way: - XSpiPs_LookupConfig(DeviceId) - Use the divide identifier to
find the static configuration structure defined in xspips_g.c. This is setup by
the tools. For some operating systems the config structure will be initialized
by the software and this call is not needed. - XSpiPs_CfgInitialize(InstancePtr,
CfgPtr, EffectiveAddr) - Uses a configuration structure provided by the caller.
If running in a system with address translation, the provided virtual memory
base address replaces the physical address present in the configuration
structure. <b>Multiple Masters</b> More than one master can exist, but
arbitration is the responsibility of the higher layer software. The device
driver does not perform any type of arbitration. <b>Multiple Slaves</b>
Contention between multiple masters is detected by the hardware, in which case a
mode fault occurs on the device. The device is disabled immediately by hardware,
and the current word transfer is stopped. The Aborted word transfer due to the
mode fault is resumed once the devie is enabled again. <b>Modes of Operation</b>
There are four modes to perform a data transfer and the selection of a mode is
based on Chip Select(CS) and Start. These two options individually, can be
controlled either by software(Manual) or hardware(Auto). - Auto CS: Chip select
is automatically asserted as soon as the first word is written into the TXFIFO
and deasserted when the TXFIFO becomes empty - Manual CS: Software must assert
and deassert CS. - Auto Start: Data transmission starts as soon as there is data
in the TXFIFO and stalls when the TXFIFO is empty - Manual Start: Software must
start data transmission at the beginning of the transaction or whenever the
TXFIFO has become empty The preferred combination is Manual CS and Auto Start.
In this combination, the software asserts CS before loading any data into
TXFIFO. In Auto Start mode, whenever data is in TXFIFO, controller sends it out
until TXFIFO becomes empty. The software reads the RXFIFO whenever the data is
available. If no further data, software disables CS. Risks/challenges of other
combinations: - Manual CS and Manual Start: Manual Start bit should be set after
each TXFIFO write otherwise there could be a race condition where the TXFIFO
becomes empty before the new word is written. In that case the transmission
stops. - Auto CS with Manual or Auto Start: It is very difficult for software to
keep the TXFIFO filled. Whenever the TXFIFO runs empty, CS is deasserted. This
results in a single transaction to be split into multiple pieces each with its
own chip select. This will result in garbage data to be sent. <b>Interrupts</b>
The user must connect the interrupt handler of the driver,
XSpiPs_InterruptHandler, to an interrupt system such that it will be called when
an interrupt occurs. This function does not save and restore the processor
context such that the user must provide this processing. The driver handles the
following interrupts: - Data Transmit Register/FIFO Underflow - Data Receive
Register/FIFO Full - Data Receive Register/FIFO Not Empty - Data Transmit
Register/FIFO Full - Data Transmit Register/FIFO Overwater - Mode Fault Error -
Data Receive Register/FIFO Overrun The Data Transmit Register/FIFO Overwater
interrupt -- indicates that the SPI device has transmitted the data available to
transmit, and now its data register and FIFO is ready to accept more data. The
driver uses this interrupt to indicate progress while sending data. The driver
may have more data to send, in which case the data transmit register and FIFO is
filled for subsequent transmission. When this interrupt arrives and all the data
has been sent, the driver invokes the status callback with a value of
XST_SPI_TRANSFER_DONE to inform the upper layer software that all data has been
sent. The Data Transmit Register/FIFO Underflow interrupt -- indicates that, as
slave, the SPI device was required to transmit but there was no data available
to transmit in the transmit register (or FIFO). This may not be an error if the
master is not expecting data. But in the case where the master is expecting
data, this serves as a notification of such a condition. The driver reports this
condition to the upper layer software through the status handler. The Data
Receive Register/FIFO Overrun interrupt -- indicates that the SPI device
received data and subsequently dropped the data because the data receive
register and FIFO was full. The interrupt applies to both master and slave
operation. The driver reports this condition to the upper layer software through
the status handler. This likely indicates a problem with the higher layer
protocol, or a problem with the slave performance. The Mode Fault Error
interrupt -- indicates that while configured as a master, the device was
selected as a slave by another master. This can be used by the application for
arbitration in a multimaster environment or to indicate a problem with
arbitration. When this interrupt occurs, the driver invokes the status callback
with a status value of XST_SPI_MODE_FAULT. It is up to the application to
resolve the conflict. When configured as a slave, Mode Fault Error interrupt
indicates that a slave device was selected as a slave by a master, but the slave
device was disabled. When configured as a master, Mode Fault Error interrupt
indicates that another SPI device is acting as a master on the bus. <b>Polled
Operation</b> Transfer in polled mode is supported through a separate interface
function XSpiPs_PolledTransfer(). Unlike the transfer function in the interrupt
mode, this function blocks until all data has been sent/received. <b>Device
Busy</b> Some operations are disallowed when the device is busy. The driver
tracks whether a device is busy. The device is considered busy when a data
transfer request is outstanding, and is considered not busy only when that
transfer completes (or is aborted with a mode fault error). This applies to both
master and slave devices. <b>Device Configuration</b> The device can be
configured in various ways during the FPGA implementation process. Configuration
parameters are stored in the xspips_g.c file or passed in via
XSpiPs_CfgInitialize(). A table is defined where each entry contains
configuration information for an SPI device, including the base address for the
device. <b>RTOS Independence</b> This driver is intended to be RTOS and
processor independent. It works with physical addresses only. Any needs for
dynamic memory management, threads or thread mutual exclusion, virtual memory,
or cache control must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 drg/jz
01/25/10 First release 1.00 sdm 10/25/11 Removed the Divide by 2 in the SPI
Clock Prescaler options as this is not supported in the device. 1.01 sg 03/07/12
Updated the code to always clear the relevant bits before writing to config
register. Always clear the slave select bits before write and clear the bits to
no slave at the end of transfer Modified the Polled transfer transmit/receive
logic. Tx should wait on TXOW Interrupt and Rx on RXNEMTY. 1.02 sg 05/31/12
Updated XSPIPS_FIFO_DEPTH to 128 from 32 to match HW for CR 658289 1.03 sg
09/21/12 Added memory barrier dmb in polled transfer and interrupt handler to
overcome the clock domain crossing issue in the controller. For CR 679252. 1.04a
sg 01/30/13 Created XSPIPS_MANUAL_START_OPTION. Created macros XSpiPs_IsMaster,
XSpiPs_IsManualStart and XSpiPs_IsManualChipSelect. Changed SPI Enable/Disable
macro argument from BaseAddress to Instance Pointer. Added DelayNss argument to
SetDelays and GetDelays API's. Added macros to set/get the RX Watermark
value.Created macros XSpiPs_IsMaster, XSpiPs_IsManualStart and
XSpiPs_IsManualChipSelect. Changed SPI transfer logic for polled and interrupt
modes to be based on filled tx fifo count and receive based on it. RXNEMPTY
interrupt is not used. SetSlaveSelect API logic is modified to drive the bit
position low based on the slave select value requested. GetSlaveSelect API will
return the value based on bit position that is low. Created
XSPIPS_CR_MODF_GEN_EN_MASK macro and added it to XSPIPS_CR_RESET_STATE. Created
XSPIPS_IXR_WR_TO_CLR_MASK for interrupts which need write-to-clear. Added shift
and mask macros for d_nss parameter. Added Rx Watermark mask. 1.05a hk 26/04/13
Added disable and enable in XSpiPs_SetOptions when CPOL/CPHA bits are set/reset.
Fix for CR707669. 1.06a hk 08/22/13 Changed GetSlaveSelect function. CR 727866.
Added masking ConfigReg before writing in SetSlaveSel Added extended slave
select support - CR722569. Added prototypes of reset API and related constant
definitions. Added check for MODF in polled transfer function. 3.0 vm 12/09/14
Modified driver source code for MISRA-C:2012 compliance. Support for Zynq
Ultrascale Mp added. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. ms 04/05/17 Modified Comment lines in functions of spips
examples to recognize it as documentation block for doxygen generation and also
modified filename tag in eeprom interrupt, eeprom polled and flash polled files
to include them in doxygen examples. 3.1 tjs 04/12/18 InputClockHz parameter
copied in instance for use in application. CR998910 3.2 aru 01/20/19 Fixes
violations according to MISRAC-2012 in safety mode and done changes such as
Declared the pointer param as Pointer to const. 3.2 nsk 03/26/19 Add support for
versal - CR 1025583. 3.3 mus 04/05/19 Replaced XPLAT_versal macro with
XPLAT_VERSAL, to be in sync with standalone BSP 3.3 akm 08/06/19 Initialized
DeviceID in XSpiPs_CfgInitialize function. </pre>

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_g.c @addtogroup
spips_v3_3 @{ This file contains a configuration table that specifies the
configuration of SPI devices in the system. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 drg/jz 01/25/10 First release 2.00 hk
22/01/14 Added check for picking second instance 3.00 kvn 02/13/15 Modified code
for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_hw.c @addtogroup
spips_v3_3 @{ Contains the reset and post boot rom state initialization.
Function prototypes in xspips_hw.h <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.06a hk 08/22/13 First release. 3.00 kvn 02/13/15
Modified code for MISRA-C:2012 compliance. 3.02 raw 11/23/15 Updated
XSpiPs_ResetHw() to read all RXFIFO entries. This change is to tackle CR910231.
3.1 tjs 11/23/18 Added a check for A72 and R5 processor to avoid changes made
for the workaround DT842463. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_hw.h @addtogroup
spips_v3_3 @{ This header file contains the identifiers and basic driver
functions (or macros) that can be used to access the device. Other driver
functions are defined in xspips.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 drg/jz 01/25/10 First release 1.02a sg
05/31/12 Updated XSPIPS_FIFO_DEPTH to 128 from 32 to match HW for CR 658289
1.04a sg 01/30/13 Created XSPIPS_CR_MODF_GEN_EN_MASK macro and added it to
XSPIPS_CR_RESET_STATE. Created XSPIPS_IXR_WR_TO_CLR_MASK for interrupts which
need write-to-clear. Added shift and mask macros for d_nss parameter. Added Rx
Watermark mask. 1.06a hk 08/22/13 Added prototypes of reset API and related
constant definitions. 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. </pre>

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_options.c @addtogroup
spips_v3_3 @{ Contains functions for the configuration of the XSpiPs driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00
drg/jz 01/25/10 First release 1.00 sdm 10/25/11 Removed the Divide by 2 in the
SPI Clock Prescaler options as this is not supported in the device 1.04a sg
01/30/13 Added XSPIPS_MANUAL_START_OPTION. SetDelays and GetDelays API's include
DelayNss parameter. 1.05a hk 26/04/13 Added disable and enable in
XSpiPs_SetOptions when CPOL/CPHA bits are set/reset. Fix for CR707669. 3.00 kvn
02/13/15 Modified code for MISRA-C:2012 compliance. 3.2 aru 01/20/19 Fixes
violations according to MISRAC-2012 in safety mode and done changes such as
Declared the pointer param as Pointer to const </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_selftest.c @addtogroup
spips_v3_3 @{ This component contains the implementation of selftest functions
for an SPI device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 drg/jz 01/25/10 First release 1.04a sg 01/30/13 SetDelays test
includes DelayTestNss parameter. 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. 3.2 aru 01/20/19 Fixes violations according to
MISRAC-2012 in safety mode and done changes such as Added goto statements.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspips_sinit.c @addtogroup
spips_v3_3 @{ The implementation of the XSpiPs driver's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 drg/jz 01/25/10 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/spips/src/xspips_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. . MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 adk 16/04/14 Initial release

FILES:
XilinxProcessorIPLib/drivers/srio/data/srio.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 adk 16/04/14 Initial release

FILES:
XilinxProcessorIPLib/drivers/srio/data/srio.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsrio_dma_loopback_example.c
This file demonstrates how to use xsrio driver on the Xilinx SRIO Gen2 Core. The
SRIO Gen2 comprised of phy, logical and transport and buffer layers. Using this
IP We can generate both messaging and read/write semantics. This example
demonstartes how to generate SWRITE(Streaming Write) transactions on the core.
Inorder to test this example external loopback is required at the boardlevel
Between the SRIO Tx and Rx pins. H/W Requirments: Inorder to test this example
at the h/w level the the SRIO Initiator Request is connected to the AXI DMA MM2S
Channel and SRIO Target Request is connected to the AXI DMA S2MM Channel. S/W
Flow: 1) The system consists of two different memories.Processor runs this
example Code in one memory and the SRIO packet is formed in another memory. 2)
The SRIO Packet is framed in the Memory 3) Configure the AXI DMA MM2S source
address and S2MM for Destiantion address and specify the byte count for both the
channels and then start the dma. 4) Compare the Data. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 adk 16/04/14 Initial
release 1.1 ms 01/23/17 Modified xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. ms 04/05/17 Added tabspace for return statements in
functions for proper documentation while generating doxygen. </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/srio/examples/xsrio_dma_loopback_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsrio.c @addtogroup srio_v1_2
@{ This file contains the required functions for the XSrio driver. See the
xsrio.h header file for more details on this driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 adk 16/04/14 Initial release 1.1 sk
11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the
prototype of XSrio_CfgInitialize API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/srio/src/xsrio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsrio.h @addtogroup srio_v1_2
@{ @details This file contains the implementation of the SRIO Gen2 driver. User
documentation for the driver functions is contained in this file in the form of
comment blocks at the front of each function. The SRIO Gen2 Core supports
RapidIO Interconnect Specification rev. 2.2 The SRIO Gen2 Endpoint comprises of
the phy ,logical and transport and buffer layers. Using the SRIO Gen2 Endpoint
Core we can generate I/O transactions Read(NREAD), Write(NWRITE), Read with
response (NREAD_R), Stream write(SWRITE) atomic operations(atomic set,clear,test
and swap etc...). It also supports Messaging Transactions Message (MESSAGE),
Doorbell(DOORBELL)and 8-bit/16-bit device ID's. <b>Initialization &
Configuration</b> The XSrio_Config structure is used by the driver to configure
itself. This configuration structure is typically created by the tool-chain
based on HW build properties. To support multiple runtime loading and
initialization strategies employed by various operating systems, the driver
instance can be initialized in the following way: - XSrio_LookupConfig(DeviceId)
- Use the device identifier to find the static configuration structure defined
in xsrio_g.c. This is setup by the tools. For some operating systems the config
structure will be initialized by the software and this call is not needed. -
XSrio_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) - Uses a configuration
structure provided by the caller. If running in a system with address
translation, the provided virtual memory base address replaces the physical
address present in the configuration structure. <b>Interrupts</b> There are no
interrupts available for the SRIO Gen2 Core. <b> Examples </b> There is an
example provided to show the usage of the APIs - SRIO Dma loopback example
(xsrio_dma_loopback_example.c) <b> Asserts </b> Asserts are used within all
Xilinx drivers to enforce constraints on argument values. Asserts can be turned
off on a system-wide basis by defining, at compile time, the NDEBUG identifier.
By default, asserts are turned on and it is recommended that users leave asserts
on during development. <b>RTOS Independence</b> This driver is intended to be
RTOS and processor independent. It works with physical addresses only. Any needs
for dynamic memory management, threads or thread mutual exclusion, virtual
memory, or cache control must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 adk 16/04/14
Initial release. 1.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR
867425. Changed the prototype of XSrio_CfgInitialize API. ms 01/23/17 Modified
xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. ms 04/05/17 Added tabspace for return statements in
functions of srio examples for proper documentation while generating doxygen.
1.2 adk 30/07/19 Fix portwidth handling in the XSrio_CfgInitialize() API. </pre>

FILES:
XilinxProcessorIPLib/drivers/srio/src/xsrio.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsrio_g.c @addtogroup srio_v1_2
@{ This file contains a configuration table that specifies the configuration of
SRIO devices in the system. Each SRIO device in the system should have an entry
in the table. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 adk 16/04/14 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/srio/src/xsrio_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsrio_hw.h @addtogroup
srio_v1_2 @{ This header file contains identifiers and macros that can be used
to access the Axi srio gen2 device. The driver APIs/functions are defined in
xsrio.h. @note MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
--------------------------------------------------------- 1.0 adk 16/04/14
Initial release.

FILES:
XilinxProcessorIPLib/drivers/srio/src/xsrio_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsrio_sinit.c @addtogroup
srio_v1_2 @{ This file contains static Initialization functionality for Xilinx
SRIO Gen2 Core driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 adk 16/04/14 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/srio/src/xsrio_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 6.0 adk 10/12/13 Removed support for
xps_sysmon_adc 7.0 bss 7/25/14 Added support for Ultrascale.

FILES:
XilinxProcessorIPLib/drivers/sysmon/data/sysmon.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 7.0 bss 7/25/14 Added support for Ultrascale.
7.2 adk 14/03/16 Fix compilation issues when sysmon is configured with streaming
interface CR940976 7.4 ms 04/18/17 Modified tcl file to add suffix U for all
macros definitions of sysmon in xparameters.h uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/sysmon/data/sysmon.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 6.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_Jm - Added support for generation of multiple
applications. All TCL procedures are now required to have a software project
type as its first argument @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl
Software Project Types (swproj): 0 : MemoryTest - Calls basic memorytest
routines from common driver dir 1 : PeripheralTest - Calls any existing
polled_example and/or selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/sysmon/data/sysmon_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_aux_polled_example.c
This file contains a design example using the driver functions of the System
Monitor/ADC driver. This example shows the usage of the driver/device in polled
mode with external mux and XADC in continuous pass Sequencer mode. It is
provided to illustrate the usage of external mux. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ----- -------- 7.5 mn 09/12/18 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_aux_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_extmux_example.c This
file contains a design example using the driver functions of the System
Monitor/ADC driver. This example shows the usage of the driver/device in
interrupt mode with external mux and XADC in Simulateneous Sequencer mode. This
example hasn't been tested with the analog inputs connected through external
mux. It is provided to illustrate the usage of external mux. @note This code
assumes that no Operating System is being used. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 5.00a sdm 08/30/11 First release 5.03a bss
04/25/13 Modified SysMonIntrExample function to set Sequencer Mode as Safe mode
instead of Single channel mode before configuring Sequencer registers. CR 703729
7.3 ms 01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_extmux_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_intr_example.c This
file contains a design example using the driver functions of the System
Monitor/ADC driver. This example here shows the usage of the driver/device in
interrupt mode to handle on-chip temperature and voltage alarm interrupts. @note
This code assumes that no Operating System is being used. The values of the on-
chip temperature and the on-chip Vccaux voltage are read from the device and
then the alarm thresholds are set in such a manner that the alarms occur. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv
05/22/07 First release 2.00a sv 06/22/08 Modified the function description of
the interrupt handler 2.00a sdm 09/26/08 Added code to return temperature value
to the main function. TestappPeripheral prints the temperature 4.00a ktn
10/22/09 Updated the example to use HAL processor APIs/macros. Updated the
example to use macros that have been renamed to remove _m from the name of the
macro. 5.03a bss 04/25/13 Modified SysMonIntrExample function to set Sequencer
Mode as Safe mode instead of Single channel mode before configuring Sequencer
registers. CR 703729 7.2 adk 29/02/16 Updated example to support Zynq and
ZynqMP. 7.3 ms 01/23/17 Added xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_intr_printf_example.c
This file contains a design example using the driver functions of the System
Monitor/ADC driver. This example here shows the usage of the driver/device in
interrupt mode to handle on-chip temperature and voltage alarm interrupts. @note
This code assumes that no Operating System is being used. The values of the on-
chip Temperature, VccInt voltage and VccAux voltage are read from the device and
then the alarm thresholds are set in such a manner that the alarms occur. This
examples also assumes that there is a STDIO device in the system. This example
has floating point calculations and uses printfs for outputting floating point
data, therefore the memory allocated for the Stack must be more. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv
05/22/07 First release 2.00a sv 06/22/08 Added printfs and used conversion
macros 4.00a ktn 10/22/09 Updated the example to use HAL Processor APIs/macros.
Updated the example to use macros that have been renamed to remove _m from the
name of the macro. 5.01a bss 03/13/12 Updated for Zynq. 5.03a bss 04/25/13
Modified SysMonIntrExample function to set Sequencer Mode as Safe mode instead
of Single channel mode before configuring Sequencer registers. CR 703729 7.3 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 04/05/17 Modified Comment lines in functions to recognize
it as documentation block for doxygen generation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_intr_printf_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_low_level_example.c
This file contains a design example using the basic driver functions of the
System Monitor driver. The example here shows using the driver/device in polled
mode to check the on-chip temperature and voltages. @note The values of the on-
chip temperature and the on-chip Vccaux voltage are read from the device and
then the alarm thresholds are set in such a manner that the alarms occur. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv
05/22/07 First release 2.00a sv 07/07/08 Changed the example to read 16 bits of
data from the the ADC data registers. 4.00a ktn 10/22/09 Updated the example to
use macros that have been renamed to remove _m from the name of the macro. 5.01a
bss 03/13/12 Modified while loop condition to wait for EOS bit to become high
5.03a bss 04/25/13 Modified SysMonLowLevelExample function to set Sequencer Mode
as Safe mode instead of Single channel mode before configuring Sequencer
registers. CR 703729 7.3 ms 01/23/17 Added xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_polled_example.c This
file contains a design example using the driver functions of the System Monitor
driver. The example here shows the driver/device in polled mode to check the on-
chip temperature and voltages. @note The values of the on-chip temperature and
the on-chip Vccaux voltage are read from the device and then the alarm
thresholds are set in such a manner that the alarms occur. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv 05/22/07 First
release 2.00a sdm 09/26/08 Added code to return temperature value to the main
function. TestappPeripheral prints the temperature 4.00a ktn 10/22/09 Updated
the example to use macros that have been renamed to remove _m from the name of
the macro. 5.03a bss 04/25/13 Modified SysMonPolledExample function to set
Sequencer Mode as Safe mode instead of Single channel mode before configuring
Sequencer registers. CR 703729 7.3 ms 01/23/17 Added xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_polled_printf_example.c
This file contains a design example using the driver functions of the System
Monitor driver. The example here shows the driver/device in polled mode to check
the on-chip temperature and voltages. @note This examples also assumes that
there is a STDIO device in the system. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.00a xd/sv 05/22/07 First release 2.00a sv
06/22/08 Added printfs and used conversion macros 4.00a ktn 10/22/09 Updated the
example to use macros that have been renamed to remove _m from the name of the
macro. 5.03a bss 04/25/13 Modified SysMonPolledPrintfExample function to set
Sequencer Mode as Safe mode instead of Single channel mode before configuring
Sequencer registers. CR 703729 7.3 ms 01/23/17 Added xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. ms 04/05/17 Modified
Comment lines in functions to recognize it as documentation block for doxygen
generation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_polled_printf_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xsysmon_single_ch_intr_example.c This file contains a design example using the
driver functions of the System Monitor/ADC driver. This example here shows the
usage of the driver/device in single channel interrupt mode to handle End of
Conversion (EOC) and VCCINT alarm interrupts. @note This code assumes that no
Operating System is being used. The value of the on-chip Vccint voltage is read
from the device and then the alarm thresholds are set in such a manner that the
alarm occurs. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.00a sv 09/04/07 First release 4.00a ktn 10/22/09 Updated the example
to use HAL Processor APIs/macros. Updated the example to use macros that have
been renamed to remove _m from the name of the macro. 7.3 vns 15/04/16 Updated
example to support ZynqMP ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/examples/xsysmon_single_ch_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon.c @addtogroup
sysmon_v7_5 @{ This file contains the driver API functions that can be used to
access the System Monitor/ADC device. Refer to the xsysmon.h header file for
more information about this driver. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a xd/sv 05/22/07 First release 2.00a
sv 07/07/08 Modified the ADC data functions to return 16 bits of data. 3.00a sdm
09/02/09 Added APIs for V6 SysMon. 4.00a ktn 10/22/09 Updated the file to use
the HAL processor APIs/macros. The macros have been renamed to remove _m from
the name of the macro. 5.00a sdm 06/15/11 Added support for XADC (7 Series
Families). 5.01a bss 02/28/12 Added support for Zynq. 5.02a bss 11/23/12 Added
XSysMon_EnableTempUpdate, XSysMon_DisableTempUpdate and
XSysMon_SetTempWaitCycles APIs (CR 679872) 5.03a bss 04/25/13 Modified
XSysMon_SetSeqChEnables, XSysMon_SetSeqAvgEnables, XSysMon_SetSeqInputMode and
XSysMon_SetSeqAcqTime APIs to check for Safe Mode instead of Single Channel
mode. CR 703729 7.0 bss 7/25/14 Modified XSysMon_GetAdcData,
XSysMon_GetMinMaxMeasurement, XSysMon_SetSingleChParams,
XSysMon_SetAlarmEnables, XSysMon_GetAlarmEnables,XSysMon_SetSeqChEnables,
XSysMon_GetSeqChEnables,XSysMon_SetSeqAvgEnables,
XSysMon_GetSeqAvgEnables,XSysMon_SetAlarmThreshold and XSysMon_GetAlarmThreshold
to support Ultrascale 7.2 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototype of XSysMon_CfgInitialize API. 7.2
asa Made changes to use XSM_CFR3_OFFSET (configuration register 3) only for
Ultrascale. Changes were made in APIs XSysMon_SetAlarmEnables and
XSysMon_GetAlarmEnables. This is to fix CR910905. 7.5 mn 07/06/18 Fixed Doxygen
warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/src/xsysmon.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon.h @addtogroup
sysmon_v7_5 @{ @details The XSysMon driver supports the Xilinx System
Monitor/ADC device. The System Monitor/ADC device has the following features: -
10-bit, 200-KSPS (kilo samples per second) Analog-to-Digital Converter (ADC) -
Monitoring of on-chip supply voltages and temperature - 1 dedicated differential
analog-input pair and 16 auxiliary differential analog-input pairs - Automatic
alarms based on user defined limits for the on-chip supply voltages and
temperature - Automatic Channel Sequencer, programmable averaging, programmable
acquisition time for the external inputs, unipolar or differential input
selection for the external inputs - Inbuilt Calibration - Optional interrupt
request generation - External Mux (7 Series and Zynq XADC) The user should refer
to the hardware device specification for detailed information about the device.
This header file contains the prototypes of driver functions that can be used to
access the System Monitor/ADC device. <b> System Monitor Channel Sequencer Modes
</b> The System Monitor Channel Sequencer supports the following operating
modes: - <b> Default </b>: This is the default mode after power up. In this mode
of operation the System Monitor operates in a sequence mode, monitoring the on
chip sensors: Temperature, VCCINT, and VCCAUX. - <b> One pass through sequence
</b>: In this mode the System Monitor converts the channels enabled in the
Sequencer Channel Enable registers for a single pass and then stops. - <b>
Continuous cycling of sequence </b>: In this mode the System Monitor converts
the channels enabled in the Sequencer Channel Enable registers continuously. -
<b> Single channel mode</b>: In this mode the System Monitor Channel Sequencer
is disabled and the System Monitor operates in a Single Channel Mode. The System
Monitor can operate either in a Continuous or Event driven sampling mode in the
single channel mode. - <b> Simultaneous sampling mode</b>: This mode is
available only in 7 Series and Zynq XADC devices. In this mode both ADCs sample
and digitizes two different analog input signals at the same time. - <b>
Independent ADC mode</b>: This mode is available only in 7 Series and Zynq XADC
devices. In this mode ADC A is used to implement a fixed monitoring mode which
is similar to default mode, but the fixed alarm functions are enabled. ADC B is
available to be used with the external analog input channels only. <b>
Initialization and Configuration </b> The device driver enables higher layer
software (e.g., an application) to communicate to the System Monitor/ADC device.
XSysMon_CfgInitialize() API is used to initialize the System Monitor/ADC device.
The user needs to first call the XSysMon_LookupConfig() API which returns the
Configuration structure pointer which is passed as a parameter to the
XSysMon_CfgInitialize() API. <b>Interrupts</b> The System Monitor/ADC device
supports interrupt driven mode and the default operation mode is polling mode.
The interrupt mode is available only if hardware is configured to support
interrupts. This driver does not provide a Interrupt Service Routine (ISR) for
the device. It is the responsibility of the application to provide one if
needed. Refer to the interrupt example provided with this driver for details on
using the device in interrupt mode. <b> Virtual Memory </b> This driver supports
Virtual Memory. The RTOS is responsible for calculating the correct device base
address in Virtual Memory space. <b> Threads </b> This driver is not thread
safe. Any needs for threads or thread mutual exclusion must be satisfied by the
layer above this driver. <b> Asserts </b> Asserts are used within all Xilinx
drivers to enforce constraints on argument values. Asserts can be turned off on
a system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The XSysMon driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. <b> Limitations of the driver </b> System
Monitor/ADC device can be accessed through the JTAG port and the AXI interface.
The driver implementation does not support the simultaneous access of the device
by both these interfaces. The user has to care of this situation in the user
application code. <br><br> <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ----- -------- 1.00a xd/sv 05/22/07 First release 2.00a sv 07/07/08 Added
bit definitions for new Alarm Interrupts in the Interrupt Registers. Changed the
ADC data functions to return 16 bits of data. Added macros for conversion from
Raw Data to Temperature/Voltage and vice-versa. 3.00a sdm 02/09/09 Added APIs
and bit definitions for V6 SysMon. 4.00a ktn 10/22/09 Updated the driver to use
the HAL Processor APIs/macros. The macros have been renamed to remove _m from
the name in all the driver files. 5.00a sdm 06/15/11 Added support for XADC 7
Series. 5.01a bss 02/28/12 Added support for Zynq, renamed XSM_ATR_BRAM_UPPER to
XSM_ATR_VBRAM_UPPER renamed XSM_ATR_BRAM_LOWER to XSM_ATR_VBRAM_LOWER 5.02a bss
11/23/12 Added APIs and Macros to support Temperature Updation over TEMP_OUT
port(CR 679872) 5.03a bss 04/25/13 Modified XSysMon_SetSeqChEnables,
XSysMon_SetSeqAvgEnables, XSysMon_SetSeqInputMode and XSysMon_SetSeqAcqTime APIs
to check for Safe Mode instead of Single Channel mode(CR 703729) in xsysmon.c
Modified examples: xsysmon_polled_example.c, xsysmon_low_level_example.c,
xsysmon_intr_printf_example.c, xsysmon_intr_example.c xsysmon_extmux_example.c
and xsysmon_polled_printf_example.c to set Sequencer Mode as Safe mode instead
of Single channel mode before configuring Sequencer registers. 6.0 adk 19/12/13
Updated as per the New Tcl API's 7.0 bss 7/25/14 To support Ultrascale: Added
XSM_CH_VUSR0 - XSMXSM_CH_VUSR3,XSM_MAX_VUSR0 XSM_MIN_VUSR3,XSM_ATR_VUSR0_UPPER
XSM_ATR_VUSR3_LOWER macros. Added XSM_IP_OFFSET macro(since register offsets are
different for Ultrascale compared to earlier families),Offsets,Masks for VUSER0
to VUSER3 channels, Configuration Register 3 and Sequence Registers 8 and 9 in
xsysmon_hw.h. Modified XSysMon_GetAdcData, XSysMon_GetMinMaxMeasurement,
XSysMon_SetSingleChParams, XSysMon_SetAlarmEnables,
XSysMon_GetAlarmEnables,XSysMon_SetSeqChEnables,
XSysMon_GetSeqChEnables,XSysMon_SetSeqAvgEnables,
XSysMon_GetSeqAvgEnables,XSysMon_SetAlarmThreshold and XSysMon_GetAlarmThreshold
in xsysmon.c. Modified driver tcl to generate XPAR_SYSMON_0_IP_TYPE parameter.
7.1 bss 05/06/15 Modified temperature transfer function for for Ultrascale
CR859369 7.2 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425.
Changed the prototype of XSysMon_CfgInitialize API. 7.2 adk 29/02/16 Updated
interrupt example to support Zynq and ZynqMP CR938326. 7.2 asa 11/03/16 Made
changes to use configuration register 3 only for Ultrascale. This fixes the
CR910905. 7.2 adk 14/03/16 Fix compilation issues when sysmon is configured with
streaming interface CR940976. 7.3 vns 15/04/16 Corrected Ultrascale conversion
formulae CR949949 ms 01/23/17 Added xil_printf statement in main function for
all examples to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. ms 04/05/17 Modified
Comment lines in functions of sysmon examples to recognize it as documentation
block for doxygen generation. 7.4 ms 04/18/17 Modified tcl file to add suffix U
for all macros definitions of sysmon in xparameters.h </pre>

FILES:
XilinxProcessorIPLib/drivers/sysmon/src/xsysmon.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_g.c @addtogroup
sysmon_v7_5 @{ This file contains a configuration table that specifies the
configuration of System Monitor/ADC devices in the system. See xsysmon.h for
more information about this driver. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a xd/sv 05/22/07 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/src/xsysmon_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_hw.h @addtogroup
sysmon_v7_5 @{ This header file contains identifiers and basic driver functions
(or macros) that can be used to access the System Monitor/ADC device or XADC.
Refer to the device specification for more information about this driver. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- --------
1.00a xd/sv 05/22/07 First release 2.00a sv 07/07/08 Added bit definitions for
new Alarm Interrupts in the Interrupt Registers. 3.00a sdm 02/09/09 Added
register and bit definitions for V6 SysMon. 4.00a ktn 10/22/09 The macros have
been renamed to remove _m from the name of the macro. 5.00a sdm 06/15/11 Added
new definitions for XADC. 5.01a bss 02/15/12 Updated for Zynq. 5.02a bss
11/23/12 Added macros XSM_CONVST_TEMPUPDT_MASK, XSM_CONVST_WAITCYCLES_MASK and
XSM_CONVST_WAITCYCLES_SHIFT (CR 679872) 7.0 bss 7/25/14 To support Ultrascale:
Added XSM_IP_OFFSET macro. Added Offsets and Masks for VUSER0 to VUSER3
channels. Added Configuration Register 3 and Sequence Registers 8 and 9. 7.2 asa
03/11/16 Made changes so that XSM_CFR3_OFFSET is visible only for Ultrasacle.
Fix for CR910905. </pre>

FILES:
XilinxProcessorIPLib/drivers/sysmon/src/xsysmon_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_intr.c @addtogroup
sysmon_v7_5 @{ This file contains interrupt handling API functions of the System
Monitor/ADC device. The device must be configured at hardware build time to
support interrupt for all the functions in this file to work. Refer to xsysmon.h
header file and device specification for more information. @note Calling the
interrupt functions without including the interrupt component will result in
asserts if asserts are enabled, and will result in a unpredictable behavior if
the asserts are not enabled. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ----- -------- 1.00a xd/sv 05/22/07 First release 4.00a ktn 10/22/09
Updated the file to use the HAL Processor APIs/macros. The macros have been
renamed to remove _m from the name of the macro. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/src/xsysmon_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_selftest.c @addtogroup
sysmon_v7_5 @{ This file contains a diagnostic self test function for the
XSysMon driver. The self test function does a simple read/write test of the
Alarm Threshold Register. See xsysmon.h for more information. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a xd/sv
05/22/07 First release 4.00a ktn 10/22/09 Updated the file to use the HAL
APIs/macros. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/src/xsysmon_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmon_sinit.c @addtogroup
sysmon_v7_5 @{ This file contains the implementation of the XSysMon driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a xd/sv 05/22/07 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmon/src/xsysmon_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 kvn 12/15/15 First release 2.3 mn 03/08/18 Get
Ref Clock Frequency information from design uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/data/sysmonpsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes -------- ------ -------- 2.3 ms 12/12/17 Added peripheral test support.
Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/data/sysmonpsu_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_ams_example.c This
file contains a design example using the driver functions of the System Monitor
driver. This example here shows the usage of the driver/device in single channel
sequencer off mode to measure AMS block voltages. @note This code assumes that
no Operating System is being used. The value of the on-chip Vccint voltage is
read from the device and then the alarm thresholds are set in such a manner that
the alarm occurs. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 mn 12/13/17 First release 2.4 mn 04/26/18 Remove usleeps from AMS
CTRL example </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/examples/xsysmonpsu_ams_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_intr_example.c This
file contains a design example using the driver functions of the System Monitor
driver. This example here shows the usage of the driver/device in interrupt mode
to handle on-chip temperature and voltage alarm interrupts. @note This code
assumes that no Operating System is being used. The values of the on-chip
Temperature, VccInt voltage and VccAux voltage are read from the device and then
the alarm thresholds are set in such a manner that the alarms occur. This
examples also assumes that there is a STDIO device in the system. This example
has floating point calculations and uses printfs for outputting floating point
data, therefore the memory allocated for the Stack must be more. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 kvn 12/15/15
First release 02/15/16 Corrected order of Enabling / Disabling of interrupts. ms
04/05/17 Modified Comment lines in functions to recognize it as documentation
block for doxygen generation. 2.3 ms 12/12/17 Added peripheral test support mn
03/08/18 Update code to run at higher frequency </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/examples/xsysmonpsu_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_low_level_example.c
This file contains a design example using the basic driver functions of the
System Monitor driver. The example here shows using the driver/device in polled
mode to check the on-chip temperature and voltages. @note The values of the on-
chip temperature and the on-chip Vccaux voltage are read from the device and
then the alarm thresholds are set in such a manner that the alarms occur. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 kvn 12/15/15
First release mn 03/08/18 Update code to run at higher frequency </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/examples/xsysmonpsu_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_polled_example.c
This file contains a design example using the driver functions of the System
Monitor driver. The example here shows the driver/device in polled mode to check
the on-chip temperature and voltages. @note This examples also assumes that
there is a STDIO device in the system. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.0 kvn 12/15/15 First release ms 04/05/17 Modified
Comment lines in functions to recognize it as documentation block for doxygen
generation. 2.3 ms 12/12/17 Added peripheral test support. mn 03/08/18 Update
code to run at higher frequency and remove sleep </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/examples/xsysmonpsu_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xsysmonpsu_single_ch_intr_example.c This file contains a design example using
the driver functions of the System Monitor driver. This example here shows the
usage of the driver/device in single channel interrupt mode to handle End of
Conversion (EOC) and VCCINT alarm interrupts. @note This code assumes that no
Operating System is being used. The value of the on-chip Vccint voltage is read
from the device and then the alarm thresholds are set in such a manner that the
alarm occurs. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 kvn 12/15/15 First release 02/15/16 Corrected order of Enabling /
Disabling of interrupts. mn 03/08/18 Update code to run at higher frequency
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/examples/xsysmonpsu_single_ch_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu.c @addtogroup
sysmonpsu_v2_5 Functions in this file are the minimum required functions for the
XSysMonPsu driver. See xsysmonpsu.h for a detailed description of the driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 kvn 12/15/15 First release. 02/15/16 Corrected Assert function call
in XSysMonPsu_GetMonitorStatus API. 03/03/16 Added Temperature remote channel
for Setsingle channel API. Also corrected external mux channel numbers. 1.1 kvn
05/05/16 Modified code for MISRA-C:2012 Compliance. 2.0 vns 08/14/16 Fixed CR
956780, added support for enabling/disabling SEQ_CH2 and SEQ_AVG2 registers,
modified function prototypes of XSysMonPsu_GetSeqAvgEnables,
XSysMonPsu_SetSeqAvgEnables, XSysMonPsu_SetSeqChEnables,
XSysMonPsu_GetSeqChEnables, XSysMonPsu_SetSeqInputMode,
XSysMonPsu_GetSeqInputMode, XSysMonPsu_SetSeqAcqTime and
XSysMonPsu_GetSeqAcqTime to provide support for set/get 64 bit value. 2.1 sk
03/03/16 Check for PL reset before doing PL Sysmon reset. 2.3 mn 12/13/17
Correct the AMS block channel numbers mn 03/08/18 Update Clock Divisor to the
proper value 2.4 mn 04/20/18 Remove looping check for PL accessible bit 2.5 mn
07/06/18 Fixed Cppcheck warnings mn 07/31/18 Modified code for MISRA-C:2012
Compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/src/xsysmonpsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu.h @addtogroup
sysmonpsu_v2_5 The XSysMon driver supports the Xilinx System Monitor device. The
System Monitor device has the following features: - PL Sysmon instance has
10-bit, 200-KSPS (kilo samples per second) Analog-to-Digital Converter (ADC) -
PS Sysmon instance has 10-bit, 1000-KSPS ADC. - Monitoring of on-chip supply
voltages and temperature - 1 dedicated differential analog-input pair and 16
auxiliary differential analog-input pairs - Automatic alarms based on user
defined limits for the on-chip supply voltages and temperature - Automatic
Channel Sequencer, programmable averaging, programmable acquisition time for the
external inputs, unipolar or differential input selection for the external
inputs - Inbuilt Calibration - Optional interrupt request generation - External
Mux The user should refer to the hardware device specification for detailed
information about the device. This header file contains the prototypes of driver
functions that can be used to access the System Monitor device. <b> System
Monitor Channel Sequencer Modes </b> The System Monitor Channel Sequencer
supports the following operating modes: - <b> Default </b>: This is the default
mode after power up. In this mode of operation the System Monitor operates in a
sequence mode, monitoring the on chip sensors: Temperature, VCCINT, and VCCAUX.
- <b> One pass through sequence </b>: In this mode the System Monitor converts
the channels enabled in the Sequencer Channel Enable registers for a single pass
and then stops. - <b> Continuous cycling of sequence </b>: In this mode the
System Monitor converts the channels enabled in the Sequencer Channel Enable
registers continuously. - <b> Single channel mode</b>: In this mode the System
Monitor Channel Sequencer is disabled and the System Monitor operates in a
Single Channel Mode. The System Monitor can operate either in a Continuous or
Event driven sampling mode in the single channel mode. <b> Initialization and
Configuration </b> The device driver enables higher layer software (e.g., an
application) to communicate to the System Monitor device.
XSysMonPsu_CfgInitialize() API is used to initialize the System Monitor device.
The user needs to first call the XSysMonPsu_LookupConfig() API which returns the
Configuration structure pointer which is passed as a parameter to the
XSysMonPsu_CfgInitialize() API. <b>Interrupts</b> The System Monitor device
supports interrupt driven mode and the default operation mode is polling mode.
This driver does not provide a Interrupt Service Routine (ISR) for the device.
It is the responsibility of the application to provide one if needed. Refer to
the interrupt example provided with this driver for details on using the device
in interrupt mode. <b> Virtual Memory </b> This driver supports Virtual Memory.
The RTOS is responsible for calculating the correct device base address in
Virtual Memory space. <b> Threads </b> This driver is not thread safe. Any needs
for threads or thread mutual exclusion must be satisfied by the layer above this
driver. <b> Asserts </b> Asserts are used within all Xilinx drivers to enforce
constraints on argument values. Asserts can be turned off on a system-wide basis
by defining, at compile time, the NDEBUG identifier. By default, asserts are
turned on and it is recommended that users leave asserts on during development.
<b> Building the driver </b> The XSysMonPsu driver is composed of several source
files. This allows the user to build and link only those parts of the driver
that are necessary. <b> Limitations of the driver </b> System Monitor device can
be accessed through the JTAG port and the AXI interface. The driver
implementation does not support the simultaneous access of the device by both
these interfaces. The user has to take care of this situation in the user
application code. <br><br> <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ----- -------- 1.00 kvn 12/15/15 First release 02/15/16 Corrected Assert
function call in XSysMonPsu_GetMonitorStatus API. 03/03/16 Added Temperature
remote channel for Setsingle channel API. Also corrected external mux channel
numbers. 1.1 kvn 05/05/16 Modified code for MISRA-C:2012 Compliance. 2.0 vns
08/14/16 Fixed CR 956780, added support for enabling/disabling SEQ_CH2 and
SEQ_AVG2 registers, modified function prototypes of XSysMonPsu_GetSeqAvgEnables,
XSysMonPsu_SetSeqAvgEnables, XSysMonPsu_SetSeqChEnables,
XSysMonPsu_GetSeqChEnables, XSysMonPsu_SetSeqInputMode,
XSysMonPsu_GetSeqInputMode, XSysMonPsu_SetSeqAcqTime and
XSysMonPsu_GetSeqAcqTime to provide support for set/get 64 bit value. Added
constants XSM_CFR_ALM_SUPPLY(8-31)_MASKs to provide support for enabling extra
PS alarams. 2.1 sk 03/03/16 Check for PL reset before doing PL Sysmon reset. ms
03/17/17 Added readme.txt file in examples folder for doxygen generation. ms
04/05/17 Modified Comment lines in functions of sysmonpsu examples to recognize
it as documentation block for doxygen generation. 2.2 sk 04/14/17 Corrected
temperature conversion formulas. 2.3 mn 12/11/17 Added missing closing bracket
error when C++ is used mn 12/12/17 Added Conversion Support for voltages having
Range of 1 Volt mn 12/13/17 Correct the AMS block channel numbers ms 12/15/17
Added peripheral test support. ms 01/04/18 Provided conditional checks for
interrupt example in sysmonpsu_header.h mn 03/08/18 Update Clock Divisor to the
proper value 2.4 mn 04/20/18 Remove looping check for PL accessible bit </pre>

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/src/xsysmonpsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_g.c @addtogroup
sysmonpsu_v2_5 This file contains a configuration table that specifies the
configuration of SYSMON devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.0 kvn 04/21/15 First release. 2.5 mn
07/06/18 Added Input Clock Frequency Information </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/src/xsysmonpsu_g.c
lib/sw_apps/zynqmp_pmufw/misc/xsysmonpsu_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_hw.h @addtogroup
sysmonpsu_v2_5 This header file contains the identifiers and basic driver
functions (or macros) that can be used to access the device. Other driver
functions are defined in xsysmonpsu.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.0 kvn 12/15/15 First release 2.0 vns 08/14/16
Added CFG_REG3, SEQ_INPUT_MODE2, SEQ_ACQ2, SEQ_CH2 and SEQ_AVG2 offsets and bit
masks 2.1 sk 03/03/16 Check for PL reset before doing PL Sysmon reset. </pre>

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/src/xsysmonpsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_intr.c @addtogroup
sysmonpsu_v2_5 This file contains functions related to SYSMONPSU interrupt
handling. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- --------
1.0 kvn 12/15/15 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/src/xsysmonpsu_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_selftest.c
@addtogroup sysmonpsu_v2_5 This file contains a diagnostic self test function
for the XSysMon driver. The self test function does a simple read/write test of
the Alarm Threshold Register. See xsysmonpsu.h for more information. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0 kvn
12/15/15 First release 2.5 mn 07/06/18 Fixed Doxygen warnings </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/src/xsysmonpsu_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsu_sinit.c @addtogroup
sysmonpsu_v2_5 This file contains the implementation of the XSysMonPsu driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.0 kvn 12/15/15 First release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsu/src/xsysmonpsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 aad 30/01/19 First release aad 25/02/19 Fix
XSysMonPsv_Supply list enum when no supplies are configured uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/data/sysmonpsv.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsv_polled_example.c
This file contains a design example using the driver functions of the System
Monitor driver. The example here shows the driver/device in polled mode to check
the on-chip temperature and voltages. @note This examples also assumes that
there is a STDIO device in the system. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.0 add 02/27/19 First release 1.1 add 07/16/19
Added register unlock 1.1 add 07/21/19 Added Temperature measurement </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/examples/xsysmonpsv_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsysmonpsv_intr_example.c
This file contains a design example using the driver functions of the System
Monitor driver. The example here shows the driver/device in intr mode to check
the on-chip temperature and voltages. @note This examples also assumes that
there is a STDIO device in the system. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.1 add 7/2/19 First release </pre> / Include Files
/

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/examples/xsysmonpsv_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsv.c @addtogroup
sysmonpsv_v1_1 Functions in this file are the minimum required functions for the
XSysMonPsv driver. See xsysmonpsv.h for a detailed description of the driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 aad 20/11/18 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/src/xsysmonpsv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsv.h @addtogroup
sysmonpsv_v1_1 The XSysMon driver supports the Xilinx System Monitor device on
Versal The System Monitor device has the following features: - Measure and
monitor up to 160 voltages across the chip - Automatic alarms based on user
defined limis for the on-chip supply voltages and temperature. - Optional
interrupt request generation The user should refer to the hardware device
specification for detailed information about the device. This header file
contains the prototypes of driver functions that can be used to access the
System Monitor device. <b> Initialization and Configuration </b> The device
driver enables higher layer software (e.g., an application) to communicate to
the System Monitor device. XSysMonPsv_CfgInitialize() API is used to initialize
the System Monitor device. The user needs to first call the
XSysMonPsv_LookupConfig() API which returns the Configuration structure pointer
which is passed as a parameter to the XSysMonPsv_CfgInitialize() API.
<b>Interrupts</b> The System Monitor device supports interrupt driven mode and
the default operation mode is polling mode. This driver does not provide a
Interrupt Service Routine (ISR) for the device. It is the responsibility of the
application to provide one if needed. Refer to the interrupt example provided
with this driver for details on using the device in interrupt mode. <b> Virtual
Memory </b> This driver supports Virtual Memory. The RTOS is responsible for
calculating the correct device base address in Virtual Memory space. <b> Threads
</b> This driver is not thread safe. Any needs for threads or thread mutual
exclusion must be satisfied by the layer above this driver. <b> Asserts </b>
Asserts are used within all Xilinx drivers to enforce constraints on argument
values. Asserts can be turned off on a system-wide basis by defining, at compile
time, the NDEBUG identifier. By default, asserts are turned on and it is
recommended that users leave asserts on during development. <b> Building the
driver </b> The XSysMonPsv driver is composed of several source files. This
allows the user to build and link only those parts of the driver that are
necessary. <b> Limitations of the driver </b> System Monitor device can be
accessed through the JTAG port and the AXI interface. The driver implementation
does not support the simultaneous access of the device by both these interfaces.
The user has to take care of this situation in the user application code.
<br><br> <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- --------
1.00 aad 08/02/18 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/src/xsysmonpsv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsv_hw.h @addtogroup
sysmonpsv_v1_1 This header file contains the identifiers and basic driver
functions (or macros) that can be used to access the device. Other driver
functions are defined in xsysmonpsv.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ----- -------- 1.0 aad 11/09/18 First release 1.1 aad 07/11/19
Fixed NEW_DATA_MASK </pre>

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/src/xsysmonpsv_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsv_intr.c @addtogroup
sysmonpsv_v1_1 Functions in this file are the minimum required functions for the
XSysMonPsv driver. See xsysmonpsv.h for a detailed description of the driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 aad 20/11/18 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/src/xsysmonpsv_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsysmonpsv_sinit.c @addtogroup
sysmonpsv_v1_1 Functions in this file are the minimum required functions for the
XSysMonPsv driver. See xsysmonpsv.h for a detailed description of the driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 aad 20/11/18 First release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/sysmonpsv/src/xsysmonpsv_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 5.0 adk 12/10/13 Updated as per the New Tcl
API's 6.1 ms 04/18/17 Modified tcl file to add suffix U for all macros
definitions of tft in xparameters.h @BEGIN_CHANGELOG EDK_LS3 Updated to handle
the corner cases described in CR no. 518193 while generating canonical
definitions @END_CHANGELOG @BEGIN_CHANGELOG 14.5/ 2013.1 Updated to remove
parameters that are not applicable for AXI TFT controller - C_DCR_SPLB_SLAVE_IF,
C_DCR_BASEADDR Modified to retrieve C_BASEADDR/C_HIGHADDR CR757359.
@END_CHANGELOG uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/tft/data/tft.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtft_example.c This file
contains a design example using the driver functions of the XTft driver. This
example shows the usage of the driver/device to - Write a character and write a
string of characters - Draw a line - Turn ON/OFF the TFT Device @note
TFT_FRAME_ADDR specifies the starting address of the 2MB space for storing the
frame data and has to be defined by the user based on the system memory map.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sg
03/24/08 First release 1.00a sg 09/24/08 Updated the example to update the Video
Memory Base Address with the Memory specified by the application 2.00a ktn
07/09/09 Updated the example to poll the Vsync(Video address latch) status bit
before writing to the Address Register (AR) 4.00a bss 01/22/13 Updated the
example to use DDR_HIGH_ADDR to support for some AXI memory controllers, User
needs to define it with a valid address. 6.00 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/tft/examples/xtft_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtft.c @addtogroup tft_v6_1 @{
This file defines all the functions for the XTft driver. See the xtft.h header
file for more details on this driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a sg 03/24/08 First release 2.00a ktn 07/06/09
Added XTft_IntrEnable(), XTft_IntrDisable()and, XTft_GetVsyncStatus() functions
to access newly added Interrupt Enable and Status Register. 3.00a ktn 10/22/09
Updated driver to use the HAL APIs/macros. Removed the macros XTft_mSetPixel and
XTft_mGetPixel. 3.00a bss 01/16/12 Updated driver to remove warnings from
asserts. 3.01a sg 05/30/12 Corrected the brace error introduced in XTft_GetPixel
while changing it from macro to function for CR 647750. 3.02a bss 11/30/12 CR
690338 - Corrected the brace error introduced in XTft_GetPixel for CR 647750.
4.00a bss 01/25/13 Added support for AXI TFT controller, XTft_WriteReg and
XTft_ReadReg functions are updated Removed all functionality associated with DCR
access 6.0 sd 07/13/15 Modified the XTft_SetFrameBaseAddr API to void
XTft_SetFrameBaseAddr(XTft InstancePtr, UINTPR NewFrameBaseAddr) so that it can
be used in systems with memory greater than 4 GB Updated XTft_CfgInitialize API
so that input argument EffectiveAddr is a UINTPTR type </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tft/src/xtft.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtft.h @addtogroup tft_v6_1 @{
@details This header file contains the definitions and declarations for the high
level driver to access the Xilinx TFT Controller Device. The device has the
capability of displaying data onto a 640480 VGA TFT screen. It can take up to
256K colors. There is no interrupt mode. The functions XTft_Setpixel and
XTft_Getpixel are provided in the driver to write to and read from the
individual pixels, the color values. These are generally stored in the assigned
2MB Video Memory which is configurable. Video Memory stores each pixel value in
32bits. Out of this 2MB memory which can hold 1024 pixels per line and 512 lines
per frame data, only 640 pixels per line and 480 lines per frame are used. Each
base color Red, Green, Blue is encoded using 6 bits which sums up to 18bits
which is stored in the Dual port BRAM. <b>Initialization & Configuration</b> The
XTft_Config structure is used by the driver to configure itself. This
configuration structure is typically created by the tool-chain based on HW build
properties. To support multiple runtime loading and initialization strategies
employed by various operating systems, the driver instance can be initialized as
follows: - XTft_CfgInitialize(InstancePtr, CfgPtr, BaseAddress) - Uses a
configuration structure provided by the caller. If running in a system with
address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <b>Interrupts</b> The
TFT device supports a single interrupt which is generated for a Vsync pulse.
This driver does not provide a Interrupt Service Routine (ISR) for the device.
It is the responsibility of the application to provide one if needed. <b>RTOS
Independence</b> This driver is intended to be RTOS and processor independent.
It works with physical addresses only. Any needs for dynamic memory management,
threads or thread mutual exclusion, virtual memory, or cache control must be
satisfied by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a sg 03/24/08 First release 2.00a ktn
07/06/09 Added XTft_IntrEnable(), XTft_IntrDisable()and, XTft_GetVsyncStatus()
functions to access newly added Interrupt Enable and Status Register. 3.00a ktn
10/22/09 Updated driver to use the HAL APIs/macros. Removed the macros
XTft_mSetPixel and XTft_mGetPixel. 3.00a bss 01/16/12 Updated driver to remove
warnings from asserts. 3.01a sg 05/30/12 Corrected the brace error introduced in
XTft_GetPixel while changing it from macro to function for CR 647750. 3.02a bss
11/30/12 CR 690338 - Corrected the brace error introduced in XTft_GetPixel for
CR 647750. 4.00a bss 01/25/13 Added support for AXI TFT controller, this driver
can only be used for AXI TFT controller XTft_WriteReg and XTft_ReadReg functions
are updated Removed all functionality associated with DCR access PlbAccess and
DcrBaseAddr are removed from the XTft_Config config structure 4.01a bss 11/01/13
Modified driver tcl to retrieve C_BASEADDR/C_HIGHADDR CR757359. 5.0 adk 19/12/13
Updated as per the New Tcl API's 6.0 sd 19/08/15 Updated the BaseAddress and
VideoMemBaseAddr variables in XTft_Config to be UINTPTR to support 64 bit
addresses. Added AddrWidth to the XTft_Config structure which reflects the value
of C_M_AXI_ADDR_WIDTH. Updated to tcl add the C_M_AXI_ADDR_WIDTH parameter.
Added XTFT_AR_LSB_OFFSET and XTFT_AR_MSB_OFFSET definitions to the xtft_hw.h
file, these offsets are valid only when the Address Width is greater than 32
bits. ms 01/23/17 Added xil_printf statement in main function for all examples
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. 6.1 ms 04/18/17 Modified tcl file to add
suffix U for all macros definitions of tft in xparameters.h </pre>

FILES:
XilinxProcessorIPLib/drivers/tft/src/xtft.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtft_charcode.h @addtogroup
tft_v6_1 @{ This file contains the macro and variable definitions of character
dimensions and character array of bitmaps of ASCII characters. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sg 03/24/08
First release </pre>

FILES:
XilinxProcessorIPLib/drivers/tft/src/xtft_charcode.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtft_g.c @addtogroup tft_v6_1
@{ This file contains a configuration table that specifies the parameters of TFT
devices. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sg 03/24/08 First release 4.00a bss 01/25/13 Removed the
XPAR_TFT_0_DCR_SPLB_SLAVE_IF and XPAR_TFT_0_DCR_BASEADDR as AXI TFT controller
doesnot support them </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tft/src/xtft_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtft_hw.h @addtogroup tft_v6_1
@{ @details This file defines the macros and definitions for the Xilinx TFT
Controller device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sg 03/24/08 First release 2.00a ktn 07/06/09 Added Interrupt
Enable and Status Register Offset and, bit masks. 3.00a ktn 10/22/09 Updated
driver to use the HAL APIs/macros. Removed the macros XTft_mSetPixel and
XTft_mGetPixel. 6.0 sd 07/09/15 Added XTFT_AR_LSB_OFFSET and XTFT_AR_MSB_OFFSET
definitions to the xtft_hw.h file, these offsets are valid only when the Address
Width is greater than 32 bits. </pre>

FILES:
XilinxProcessorIPLib/drivers/tft/src/xtft_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtft_sinit.c @addtogroup
tft_v6_1 @{ This file defines the implementation of Tft device static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a sg 03/24/08 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tft/src/xtft_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 sa 04/05/17 First release

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/data/tmr_inject.mdd
XilinxProcessorIPLib/drivers/tmr_manager/data/tmr_manager.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 sa 04/05/17 First release uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/data/tmr_inject.tcl
XilinxProcessorIPLib/drivers/tmr_manager/data/tmr_manager.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 sa 04/05/17 First release Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/data/tmr_inject_tapp.tcl
XilinxProcessorIPLib/drivers/tmr_manager/data/tmr_manager_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject_low_level_example.c
This file contains a design example using the low-level driver functions and
macros of the TMRInject driver (XTMRInject). @note It is assumed that the design
is Triple Modular Redundant, such that injection of a fault will not prevent the
software from continuing to run. MODIFICATION HISTORY: <pre> Ver Who Date
Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/examples/xtmr_inject_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject_selftest_example.c
This file contains a design example using the TMR_Inject driver (XTMR_Inject)
and hardware device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/examples/xtmr_inject_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject.c @addtogroup
tmr_inject_v1_1 @{ Contains required functions for the XTMR_Inject driver. See
the xtmr_inject.h header file for more details on this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sa 04/05/17
First release 1.1 mus 10/25/18 Updated XTMR_Inject_CfgInitialize to support 64
bit fault address. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/src/xtmr_inject.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject.h @addtogroup
tmr_inject_v1_1 @{ @details This component contains the implementation of the
XTMR_Inject component which is the driver for the Xilinx TMR Inject device.
<b>Initialization & Configuration</b> The XTMR_Inject_Config structure is used
by the driver to configure itself. This configuration structure is typically
created by the tool-chain based on HW build properties. To support multiple
runtime loading and initialization strategies employed by various operating
systems, the driver instance can be initialized in one of the following ways: -
XTMR_Inject_Initialize(InstancePtr, DeviceId) - The driver looks up its own
configuration structure created by the tool-chain based on an ID provided by the
tool-chain. - XTMR_Inject_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) -
Uses a configuration structure provided by the caller. If running in a system
with address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <b>RTOS
Independence</b> This driver is intended to be RTOS and processor independent.
It works with physical addresses only. Any needs for dynamic memory management,
threads or thread mutual exclusion, virtual memory, or cache control must be
satisfied by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. 1.1 mus 10/25/18
Added new member "LMBAddrWidth" to config structure. It contains value of
C_INJECT_LMB_AWIDTH parameter. </pre>

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/src/xtmr_inject.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject_g.c @addtogroup
tmr_inject_v1_1 @{ This file contains a configuration table that specifies the
configuration of TMR Inject devices in the system. Each device in the system
should have an entry in the table. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/src/xtmr_inject_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject_i.h @addtogroup
tmr_inject_v1_1 @{ Contains data which is shared between the files of the
XTMR_Inject component. It is intended for internal use only. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release
</pre>

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/src/xtmr_inject_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject_l.h @addtogroup
tmr_inject_v1_1 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. High-level driver
functions are defined in xtmr_inject.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/src/xtmr_inject_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject_selftest.c
@addtogroup tmr_inject_v1_1 @{ This file contains the self-test functions for
the TMR Inject component (XTMR_Inject). <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/src/xtmr_inject_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_inject_sinit.c @addtogroup
tmr_inject_v1_1 @{ The implementation of the XTMRInject component's static
initialzation functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_inject/src/xtmr_inject_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_intr_example.c
This file contains a design example using the TMRManager driver (XTMRManager)
and hardware device using the interrupt mode. @note The user must provide a
physical loopback such that data which is transmitted will be received.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.0 sa
04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/examples/xtmr_manager_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xtmr_manager_intr_tapp_example.c This file contains a design example using the
TMR_Manager driver and hardware device using the interrupt mode for transmission
of data. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/examples/xtmr_manager_intr_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xtmr_manager_low_level_example.c This file contains a design example using the
low-level driver functions and macros of the TMR_Manager driver (XTMR_Manager).
@note The user must provide a physical loopback such that data which is
transmitted will be received. MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/examples/xtmr_manager_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_polled_example.c
This file contains a design example using the TMR_Manager driver (XTMR_Manager)
and hardware device using the polled mode. @note The user must provide a
physical loopback such that data which is transmitted will be received.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.0 sa
04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/examples/xtmr_manager_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_selftest_example.c
This file contains a design example using the TMR_Manager driver (XTMR_Manager)
and hardware device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/examples/xtmr_manager_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager.c @addtogroup
tmr_manager_v1_0 @{ Contains required functions for the XTMR_Manager driver. See
the xtmr_manager.h header file for more details on this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sa 04/05/17
First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager.h @addtogroup
tmr_manager_v1_0 @{ @details This component contains the implementation of the
XTMR_Manager component which is the driver for the Xilinx TMR Manager device.
Most features are configurable at run time by software, but someare only
configurable when the hardware device is built. The driver defaults to no
interrupts at initialization such that interrupts must be enabled if desired. An
interrupt is generated when a SEM event that has not been masked occurs.
<b>Initialization & Configuration</b> The XTMR_Manager_Config structure is used
by the driver to configure itself. This configuration structure is typically
created by the tool-chain based on HW build properties. To support multiple
runtime loading and initialization strategies employed by various operating
systems, the driver instance can be initialized in one of the following ways: -
XTMR_Manager_Initialize(InstancePtr, DeviceId) - The driver looks up its own
configuration structure created by the tool-chain based on an ID provided by the
tool-chain. - XTMR_Manager_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) -
Uses a configuration structure provided by the caller. If running in a system
with address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <b>RTOS
Independence</b> This driver is intended to be RTOS and processor independent.
It works with physical addresses only. Any needs for dynamic memory management,
threads or thread mutual exclusion, virtual memory, or cache control must be
satisfied by the layer above this driver. @note The driver is partitioned such
that a minimal implementation may be used. More features require additional
files to be linked in. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 sa 04/05/17 First release ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_g.c @addtogroup
tmr_manager_v1_0 @{ This file contains a configuration table that specifies the
configuration of TMR Manager devices in the system. Each device in the system
should have an entry in the table. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_i.h @addtogroup
tmr_manager_v1_0 @{ Contains data which is shared between the files of the
XTMR_Manager component. It is intended for internal use only. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release
</pre>

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_intr.c @addtogroup
tmr_manager_v1_0 @{ This file contains interrupt-related functions for the TMR
Manager component (XTMR_Manager). <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_intr.c
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_sem.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_l.h @addtogroup
tmr_manager_v1_0 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. High-level driver
functions are defined in xtmr_manager.h. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_recover.c
@addtogroup tmr_manager_v1_0 @{ This file contains the recovery handling
functions for the TMR Manager component (XTMR_Manager). <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_recover.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_selftest.c
@addtogroup tmr_manager_v1_0 @{ This file contains the self-test functions for
the TMR Manager component (XTMR_Manager). <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_sinit.c
@addtogroup tmr_manager_v1_0 @{ The implementation of the XTMR_Manager
component's static initialzation functionality. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmr_manager_stats.c
@addtogroup tmr_manager_v1_0 @{ This file contains the statistics functions for
the TMR Manager component (XTMR_Manager). <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 sa 04/05/17 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/tmr_manager/src/xtmr_manager_stats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Removed support for xps_timer
4.0 als 09/30/15 Updated initialization API. 4.5 cjp 03/22/18 Driver version
updated as PWM feature is added. 4.6 mus 03/13/19 tmrctr_tapp tcl is updated to
support scenario where AXI TIMER is interrupting ARM processor through more than
one interrupt pin. Fix for CR1024699 @BEGIN_CHANGELOG EDK_M 11/18/2009 ktn
Removed support for opb_timer @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3 06/16/10
sv Added support for axi_timer @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/tmrctr/data/tmrctr.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's 4.2 nsk 15/09/16 Updated device id for canonical define, when there is
more than one timer perpheral 4.4 ms 04/18/17 Modified tcl file to add suffix U
for all macros definitions of tmrctr in xparameters.h

FILES:
XilinxProcessorIPLib/drivers/tmrctr/data/tmrctr.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's 4.6 mus 03/13/19 Updated to support scenario where AXI TIMER is
interrupting ARM processor through more than one interrupt pin. Fix for
CR1024699 @BEGIN_CHANGELOG EDK_I - include header files @END_CHANGELOG
@BEGIN_CHANGELOG EDK_H - Added support for generation of multiple applications.
All TCL procedures are now required to have a software project type as its first
argument @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/tmrctr/data/tmrctr_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_fast_intr_example.c
This file contains a design example using the timer counter driver (XTmCtr) and
hardware device using fast interrupt mode.This example assumes that the
interrupt controller is also present as a part of the system <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a bss 07/31/12 First
release 4.2 ms 01/23/17 Added xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. 4.5 mus 07/05/18 Updated example to call
TmrCtrDisableIntr function with correct arguments. Presently device id is being
passed instead of interrupt id. It fixes CR1006251. 4.5 mus 07/05/18 Fixed
checkpatch errors and warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/examples/xtmrctr_fast_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_intr_64bit_example.c
This file contains a design example using the timer counter driver (XTmCtr) and
hardware device using interrupt mode with the counters configured in cascasde
mode for a 64 bit operation. Both the timers should enabled in HW configuration
for the cascade mode of operation. The cascade mode of operation is present in
the new versions of the axi_timer IP. Please check the HW Datasheet to see
whether this feature is present in the version of the IP that you are using.
This example assumes that the interrupt controller is also present as a part of
the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
2.04a sdm 07/15/11 Created based on the xtmrctr_intr_example 4.2 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
4.5 mus 07/05/18 Updated example to call TmrCtrDisableIntr function with correct
arguments. Presently device id is being passed instead of interrupt id. It fixes
CR1006251. 4.5 mus 07/05/18 Fixed checkpatch errors and warnings. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/examples/xtmrctr_intr_64bit_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_intr_example.c This
file contains a design example using the timer counter driver (XTmCtr) and
hardware device using interrupt mode.This example assumes that the interrupt
controller is also present as a part of the system This file can be used as a
standalone example or by the TestAppGen utility to include a test for Timer
interrupts. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00b jhl 02/13/02 First release 1.00b sv 04/26/05 Minor changes to comply to
Doxygen and coding guidelines 1.00b sn 05/09/06 Modified to be used by
TestAppGen to include test for interrupts. 2.00a ktn 10/30/09 Updated to use HAL
API's and minor changes as per coding guidelines. 2.00a ssb 01/11/01 Updated the
example to be used with the SCUGIC in Zynq. 4.2 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. 4.5 mus
07/05/18 Updated example to call TmrCtrDisableIntr function with correct
arguments. Presently device id is being passed instead of interrupt id. It fixes
CR1006251. 4.5 mus 07/05/18 Fixed checkpatch errors and warnings. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/examples/xtmrctr_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_low_level_example.c
This file contains a design example using the Timer Counter (XTmrCtr) low level
driver and hardware device in a polled mode. @note None <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl 02/13/02 First
release 1.00b sv 04/26/05 Minor changes to comply to Doxygen and coding
guidelines 2.00a ktn 10/30/09 Updated the example as the macros in the driver
are renamed by removing _m in the definition. Minor changes as per coding
guidelines are done. 4.2 ms 01/23/17 Added xil_printf statement in main function
to ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/examples/xtmrctr_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_polled_example.c This
file contains a design example using the Timer Counter driver (XTmrCtr) and
hardware device in a polled mode. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00b jhl 02/13/02 First release 1.00b sv
04/26/05 Minor changes to comply to Doxygen and coding guidelines. 2.00a ktn
11/26/09 Minor changes as per coding guidelines. 4.2 ms 01/23/17 Added
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/examples/xtmrctr_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_pwm_example.c This file
contains a design example using the timer counter driver and hardware device
using interrupt mode. The example demonstrates the use of PWM feature of axi
timers. PWM is configured to operate at specific duty cycle and after every N
cycles the duty cycle is incremented until a specific duty cycle is achieved. No
software validation of duty cycle is undergone in the example. This example
assumes that the interrupt controller is also present as a part of the system.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b cjp
03/28/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/examples/xtmrctr_pwm_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_selftest_example.c This
file contains a example for using the Timer Counter hardware and driver @note
None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
sv 04/25/05 Initial release for TestApp integration. 2.00a ktn 11/26/09 Minor
changes as per coding guidelines. 4.2 ms 01/23/17 Added xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/examples/xtmrctr_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr.c @addtogroup
tmrctr_v4_6 @{ Contains required functions for the XTmrCtr driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm
08/16/01 First release 1.00b jhl 02/21/02 Repartitioned the driver for smaller
files 1.10b mta 03/21/07 Updated to new coding style 2.00a ktn 10/30/09 Updated
to use HAL API's. _m is removed from all the macro definitions. 2.05a adk
15/05/13 Fixed the CR:693066 Added the IsStartedTmrCtr0/IsStartedTmrCtr1 members
to the XTmrCtr instance structure. The IsStartedTmrCtrX will be assigned
XIL_COMPONENT_IS_STARTED in the XTmrCtr_Start function. The IsStartedTmrCtrX
will be cleared in the XTmrCtr_Stop function. There will be no Initialization
done in the XTmrCtr_Initialize if both the timers have already started and the
XST_DEVICE_IS_STARTED Status is returned. Removed the logic in the
XTmrCtr_Initialize function which was checking the Register Value to know
whether a timer has started or not. 4.0 als 09/30/15 Updated initialization API.
4.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed
the prototype of XTmrCtr_CfgInitialize API. 4.5 cjp 03/22/18 Added APIs to
support PWM feature. XTmrCtr_PwmConfigure is used to configure PWM to operate
for specific period and high time. XTmrCtr_PwmEnable and XTmrCtr_PwmDisable are
used to enable/disable the PWM output. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr.h @addtogroup
tmrctr_v4_6 @{ @details The Xilinx timer/counter component. This component
supports the Xilinx timer/counter. More detailed description of the driver
operation can be found in the xtmrctr.c file. The Xilinx timer/counter supports
the following features: - Polled mode. - Interrupt driven mode - enabling and
disabling specific timers - PWM operation - Cascade Operation (This is to be
used for getting a 64 bit timer and this feature is present in the latest
versions of the axi_timer IP) The timer counter operates in 2 primary modes,
compare and capture. In either mode, the timer counter may count up or down,
with up being the default. Compare mode is typically used for creating a single
time period or multiple repeating time periods in the auto reload mode, such as
a periodic interrupt. When started, the timer counter loads an initial value,
referred to as the compare value, into the timer counter and starts counting
down or up. The timer counter expires when it rolls over/under depending upon
the mode of counting. An external compare output signal may be configured such
that a pulse is generated with this signal when it hits the compare value.
Capture mode is typically used for measuring the time period between external
events. This mode uses an external capture input signal to cause the value of
the timer counter to be captured. When started, the timer counter loads an
initial value, referred to as the compare value, The timer can be configured to
either cause an interrupt when the count reaches the compare value in compare
mode or latch the current count value in the capture register when an external
input is asserted in capture mode. The external capture input can be
enabled/disabled using the XTmrCtr_SetOptions function. While in compare mode,
it is also possible to drive an external output when the compare value is
reached in the count register The external compare output can be
enabled/disabled using the XTmrCtr_SetOptions function. <b>Interrupts</b> It is
the responsibility of the application to connect the interrupt handler of the
timer/counter to the interrupt source. The interrupt handler function,
XTmrCtr_InterruptHandler, is visible such that the user can connect it to the
interrupt source. Note that this interrupt handler does not provide interrupt
context save and restore processing, the user must perform this processing. The
driver services interrupts and passes timeouts to the upper layer software
through callback functions. The upper layer software must register its callback
functions during initialization. The driver requires callback functions for
timers. @note The default settings for the timers are: - Interrupt generation
disabled - Count up mode - Compare mode - Hold counter (will not reload the
timer) - External compare output disabled - External capture input disabled -
Pulse width modulation disabled - Timer disabled, waits for Start function to be
called <br><br> A timer counter device may contain multiple timer counters. The
symbol XTC_DEVICE_TIMER_COUNT defines the number of timer counters in the
device. The device currently contains 2 timer counters. <br><br> This driver is
intended to be RTOS and processor independent. It works with physical addresses
only. Any needs for dynamic memory management, threads or thread mutual
exclusion, virtual memory, or cache control must be satisfied by the layer above
this driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ecm 08/16/01 First release 1.00b jhl 02/21/02 Repartitioned the
driver for smaller files 1.10b mta 03/21/07 Updated to new coding style. 1.11a
sdm 08/22/08 Removed support for static interrupt handlers from the MDD file
2.00a ktn 10/30/09 Updated to use HAL API's. _m is removed from all the macro
definitions. 2.01a ktn 07/12/10 Renamed the macro XTimerCtr_ReadReg as
XTmrCtr_ReadReg for naming consistency (CR 559142). 2.02a sdm 09/28/10 Updated
the driver tcl to generate the xparameters for the timer clock frequency (CR
572679). 2.03a rvo 11/30/10 Added check to see if interrupt is enabled before
further processing for CR 584557. 2.04a sdm 07/12/11 Added support for cascade
mode operation. The cascade mode of operation is present in the latest versions
of the axi_timer IP. Please check the HW Datasheet to see whether this feature
is present in the version of the IP that you are using. 2.05a adk 15/05/13 Fixed
the CR:693066 Added the IsStartedTmrCtr0/IsStartedTmrCtr1 members to the XTmrCtr
instance structure. The IsStartedTmrCtrX will be assigned
XIL_COMPONENT_IS_STARTED in the XTmrCtr_Start function. The IsStartedTmrCtrX
will be cleared in the XTmrCtr_Stop function. There will be no Initialization
done in the XTmrCtr_Initialize if both the timers have already started and the
XST_DEVICE_IS_STARTED Status is returned. Removed the logic in the
XTmrCtr_Initialize function which was checking the Register Value to know
whether a timer has started or not. 3.0 adk 19/12/13 Updated as per the New Tcl
API's 4.0 als 09/30/15 Updated initialization API. 4.1 sk 11/10/15 Used UINTPTR
instead of u32 for Baseaddress CR 867425. Changed the prototype of
XTmrCtr_CfgInitialize API. 4.2 nsk 15/09/16 Updated tcl, to get correct device
id for canonical defines, when there exist more than one timer perepheral ms
01/23/17 Added xil_printf statement in main function for all examples to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. 4.4 ms 04/18/17 Modified tcl file to add suffix U for all
macros definitions of tmrctr in xparameters.h 4.5 cjp 03/22/18 Added APIs to
support PWM feature. XTmrCtr_PwmConfigure is used to configure PWM to operate
for specific period and high time. XTmrCtr_PwmEnable and XTmrCtr_PwmDisable are
used to enable/disable the PWM output. 4.6 mus 03/13/19 tmrctr_tapp tcl is
updated to support scenario where AXI TIMER is interrupting ARM processor
through more than one interrupt pin. Fix for CR1024699 </pre>

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_g.c @addtogroup
tmrctr_v4_6 @{ This file contains a configuration table that specifies the
configuration of timer/counter devices in the system. Each timer/counter device
should have an entry in this table. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a ecm 08/16/01 First release 1.00b jhl 02/21/02
Repartitioned the driver for smaller files 1.10b mta 03/21/07 Updated to new
coding style </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_i.h @addtogroup
tmrctr_v4_6 @{ This file contains data which is shared between files internal to
the XTmrCtr component. It is intended for internal use only. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl 02/06/02 First
release 1.10b mta 03/21/07 Updated to new coding style 2.00a ktn 10/30/09 _m is
removed from all the macro definitions. </pre>

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_intr.c @addtogroup
tmrctr_v4_6 @{ Contains interrupt-related functions for the XTmrCtr component.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
02/06/02 First release 1.10b mta 03/21/07 Updated to new coding style 2.00a ktn
10/30/09 Updated to use HAL API's. _m is removed from all the macro definitions.
2.03a rvo 11/30/10 Added check to see if interrupt is enabled before further
processing for CR 584557. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_l.c @addtogroup
tmrctr_v4_6 @{ This file contains low-level driver functions that can be used to
access the device. The user should refer to the hardware device specification
for more details of the device operation. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00b jhl 04/24/02 First release 1.10b mta
03/21/07 Updated to new coding style 2.00a ktn 10/30/09 Updated to use HAL API's
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_l.h @addtogroup
tmrctr_v4_6 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. The user should
refer to the hardware device specification for more details of the device
operation. High-level driver functions are defined in xtmrctr.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
04/24/02 First release 1.10b mta 03/21/07 Updated to new coding style 2.00a ktn
10/30/09 Updated to use HAL API's. _m is removed from all the macro definitions.
2.01a ktn 07/12/10 Renamed the macro XTimerCtr_ReadReg as XTmrCtr_ReadReg for
naming consistency (CR 559142). 2.04a sdm 07/12/11 Added the CASC mode bit in
the TCSRO register for the cascade mode operation. The cascade mode of operation
is present in the latest versions of the axi_timer IP. Please check the HW
Datasheet to see whether this feature is present in the version of the IP that
you are using. 4.4 mus 07/21/17 Updated XTmrCtr_DisableIntr macro to not to
clear T0INT flag 4.5 cjp 03/22/18 Added macros for timer/counter instance number
and max load value. </pre>

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_options.c @addtogroup
tmrctr_v4_6 @{ Contains configuration options functions for the XTmrCtr
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00b jhl 02/06/02 First release 1.10b mta 03/21/07 Updated to new coding style
2.00a ktn 10/30/09 Updated to use HAL API's. _m is removed from all the macro
definitions. 2.04a sdm 07/12/11 Added support for the cascade mode operation.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_selftest.c @addtogroup
tmrctr_v4_6 @{ Contains diagnostic/self-test functions for the XTmrCtr
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00b jhl 02/06/02 First release 1.10b mta 03/21/07 Updated to new coding style
2.00a ktn 10/30/09 Updated to use HAL API's. _m is removed from all the macro
definitions. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_sinit.c @addtogroup
tmrctr_v4_6 @{ This file contains static initialization methods for the XTmrCtr
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 4.0 als 09/30/15 Creation of this file. Moved LookupConfig from
xtmrctr.c. 4.4 mn 07/31/17 Resolve Compilation warning </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtmrctr_stats.c @addtogroup
tmrctr_v4_6 @{ Contains function to get and clear statistics for the XTmrCtr
component. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00b jhl 02/06/02 First release. 1.10b mta 03/21/07 Updated for new coding
style. 2.00a ktn 10/30/09 Updated to use HAL API's. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tmrctr/src/xtmrctr_stats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 2.0 adk 12/10/13 Updated as per the New Tcl
API's 3.1 ms 05/22/17 Updated the parameter naming from XPAR_TPG_NUM_INSTANCES
to XPAR_XTPG_NUM_INSTANCES to avoid compilation failure as the tools are
generating XPAR_XTPG_NUM_INSTANCES in the xtpg_g.c for fixing MISRA-C files.

FILES:
XilinxProcessorIPLib/drivers/tpg/data/tpg.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file tpg_selftest_example.c This
file contains an example using the XTpg driver to do self test on the device.
@note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------
-------- 3.0 adk 01/15/14 First release ms 04/10/17 Modified filename tag to
include the file in doxygen examples. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tpg/examples/tpg_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtpg.c @addtogroup tpg_v3_1 @{
This file contains the implementation of the interface functions for Test
Pattern Generator (TPG) driver. Refer to the header file xtpg.h for more
detailed information. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00a se 10/01/12 Initial creation. 2.0 se 01/24/13 Cleaned up
comments. 3.0 adk 02/19/14 Changed the file name form "tpg.c" to "xtpg.c".
Implemented the following functions: XTpg_CfgInitialize, XTpg_Setup,
XTpg_GetVersion, XTpg_SetActiveSize, XTpg_GetActiveSize, XTpg_SetBackground,
XTpg_GetBackground, XTpg_EnableCrossHair, XTpg_DisableCrossHair, XTpg_EnableBox,
XTpg_DisableBox, XTpg_SetComponentMask, XTpg_GetComponentMask,
XTpg_EnableStuckPixel, XTpg_DisableStuckPixel, XTPg_EnableNoise,
XTPg_DisableNoise, XTpg_EnableMotion, XTpg_DisableMotion, XTpg_SetMotionSpeed,
XTpg_GetMotionSpeed, XTpg_SetCrosshairPosition, XTpg_GetCrosshairPosition,
XTpg_SetZPlateHStart, XTpg_GetZPlateHStart, XTpg_SetZPlateHSpeed,
XTpg_GetZPlateHSpeed, XTpg_SetZPlateVStart, XTpg_GetZPlateVStart,
XTpg_SetZPlateVSpeed, XTpg_GetZPlateVSpeed, XTpg_SetBoxSize, XTpg_GetBoxSize,
XTpg_SetBoxColor, XTpg_GetBoxColor, XTpg_SetStuckPixelThreshold,
XTpg_GetStuckPixelThreshold, XTpg_SetNoiseGain, XTpg_GetNoiseGain,
XTpg_SetBayerPhase, XTpg_GetBayerPhase, XTpg_SetPattern, XTpg_GetPattern. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/tpg/src/xtpg.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtpg.h @addtogroup tpg_v3_1 @{
@details This header file contains identifiers and register-level driver
functions (or macros) that can be used to access the Xilinx Test Pattern
Generator (TPG) core instance. The TPG core provides a wide variety of tests
patterns enabling you to debug and assess video system color, quality, edge, and
motion performance. The Test Pattern Generator core produces the following
patterns in RGB, YCbCr 444, or YCbCr 422 video format. - Video input pass
through - Horizontal ramp - Vertical ramp - Temporal ramp - Flat fields (red,
green, blue, black and white) - Combined vertical and horizontal ramp - Color
bars - Tartan bars - Zone plate - Cross hairs - Cross hatch - Solid box - Motion
effect for ramps, zone plate, and solid box <b>Initialization &
Configuration</b> The device driver enables higher layer software (e.g., an
application) to communicate to the TPG core. XTpg_CfgInitialize() API is used to
initialize the TPG core. The user needs to first call the XTpg_LookupConfig()
API which returns the Configuration structure pointer which is passed as a
parameter to the XTpg_CfgInitialize() API. <b> Interrupts </b> The driver
provides an interrupt handler XTpg_IntrHandler for handling the interrupt from
the TPG core. The users of this driver have to register this handler with the
interrupt system and provide the callback functions by using XTpg_SetCallBack
API. <b> Virtual Memory </b> This driver supports Virtual Memory. The RTOS is
responsible for calculating the correct device base address in Virtual Memory
space. <b> Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver. <b>
Asserts </b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by
defining, at compile time, the NDEBUG identifier. By default, asserts are turned
on and it is recommended that users leave asserts on during development. <b>
Building the driver </b> The XTpg driver is composed of several source files.
This allows the user to build and link only those parts of the driver that are
necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a se 10/01/12 Initial creation. 2.0a se 02/12/14 Cleaned up
comments, updated masks and registers. 2.0 adk 19/12/13 Updated as per the New
Tcl API's. 3.0 adk 02/19/14 Changed the file name from "tpg.h" to "xtpg.h"
Register offsets, TPG_In32, TPG_In32, TPG_ReadReg, TPG_WriteReg and bit
definitions of tpg.h file were moved to xtpg_hw.h file. Removed the following
bit definitions : TPG_CTL_CS_MASK. Defined the following handler types as enum
values: XTPG_HANDLER_PROCSTART ,XTPG_HANDLER_FRAMEDONE and XTPG_HANDLER_ERROR.
Defined the following enums: XTpg_BackgroundPattern, XTpg_ComponentMask and
XTpg_BayerPhaseCombination. Defined the following range macros
XTPG_MOTION_SPEED_MIN, XTPG_MOTION_SPEED_MAX, XTPG_VSIZE_FIRST, XTPG_VSIZE_LAST,
XTPG_HSIZE_FIRST, XTPG_HSIZE_LAST. Added the following function macros:
XTpg_Enable, XTpg_Disable, XTpg_Start, XTpg_Stop, XTpg_RegUpdateEnable,
XTpg_RegUpdateDisable, XTpg_Reset, XTpg_SyncReset, XTpg_IntrEnable,
XTpg_IntrDisable, XTpg_StatusGetPending, XTpg_IntrGetPending, XTpg_IntrClear.
Removed following function macros: TPG_Enable, TPG_Disable, TPG_RegUpdateEnable,
TPG_RegUpdateDisable, TPG_Reset, TPG_FSyncReset TPG_ClearStatus, TPG_ClearReset.
Added the following structures XTpg and XTpg_Config. Implemented
XTpg_LookupConfig in xtpg_sinit.c Implemented XTpg_SelfTest in xtpg_selftest.c
Implemented XTpg_IntrHandler, XTpg_SetCallBack in xtpg_intr.c. Added the
register offsets and bit masks for the registers and added backward
compatibility for macros.in xtpg_hw.h. Modification history from xtpg.c file:
Changed the file name form "tpg.c" to "xtpg.c". Implemented the following
functions: XTpg_CfgInitialize, XTpg_Setup, XTpg_GetVersion, XTpg_SetActiveSize,
XTpg_GetActiveSize, XTpg_SetBackground, XTpg_GetBackground,
XTpg_EnableCrossHair, XTpg_DisableCrossHair, XTpg_EnableBox, XTpg_DisableBox,
XTpg_SetComponentMask, XTpg_GetComponentMask, XTpg_EnableStuckPixel,
XTpg_DisableStuckPixel, XTPg_EnableNoise, XTPg_DisableNoise, XTpg_EnableMotion,
XTpg_DisableMotion, XTpg_SetMotionSpeed, XTpg_GetMotionSpeed,
XTpg_SetCrosshairPosition, XTpg_GetCrosshairPosition, XTpg_SetZPlateHStart,
XTpg_GetZPlateHStart, XTpg_SetZPlateHSpeed, XTpg_GetZPlateHSpeed,
XTpg_SetZPlateVStart, XTpg_GetZPlateVStart, XTpg_SetZPlateVSpeed,
XTpg_GetZPlateVSpeed, XTpg_SetBoxSize, XTpg_GetBoxSize, XTpg_SetBoxColor,
XTpg_GetBoxColor, XTpg_SetStuckPixelThreshold, XTpg_GetStuckPixelThreshold,
XTpg_SetNoiseGain, XTpg_GetNoiseGain, XTpg_SetBayerPhase, XTpg_GetBayerPhase,
XTpg_SetPattern, XTpg_GetPattern. ms 03/17/17 Added readme.txt file in examples
folder for doxygen generation. ms 04/10/17 Modified filename tag in examples to
include them in doxygen examples. 3.1 ms 05/22/17 Updated the parameter naming
from XPAR_TPG_NUM_INSTANCES to XPAR_XTPG_NUM_INSTANCES to avoid compilation
failure as the tools are generating XPAR_XTPG_NUM_INSTANCES in the xtpg_g.c for
fixing MISRA-C files. </pre>

FILES:
XilinxProcessorIPLib/drivers/tpg/src/xtpg.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtpg_hw.h @addtogroup tpg_v3_1
@{ This header file contains the hardware register offsets and register bit
definitions for the Xilinx Test Pattern Generator (TPG) core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 3.0 adk 02/19/14 First
release. Added the register offsets and bit masks for the registers and added
backward compatibility for macros. </pre>

FILES:
XilinxProcessorIPLib/drivers/tpg/src/xtpg_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtpg_intr.c @addtogroup
tpg_v3_1 @{ This file contains interrupt related functions of the TPG core.
Please see xtpg.h for more details of the driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ----- ------- 3.0 adk 02/19/14 First Release
Implemented the following functions: XTpg_IntrHandler and XTpg_SetCallBack.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tpg/src/xtpg_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtpg_selftest.c @addtogroup
tpg_v3_1 @{ This file contains the self-test functions for the TPG driver. The
self test function reads the Version Register. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- ------- 3.0 adk 02/19/14 First Release. Implemented
XTpg_SelfTest function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tpg/src/xtpg_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtpg_sinit.c @addtogroup
tpg_v3_1 @{ This file contains static initialization methods for Xilinx TPG core
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
3.0 adk 02/19/14 First release. Implemented the following functions:
XTpg_LookupConfig. 3.1 ms 05/22/17 Updated the parameter naming from
XPAR_TPG_NUM_INSTANCES to XPAR_XTPG_NUM_INSTANCES to avoid compilation failure
as the tools are generating XPAR_XTPG_NUM_INSTANCES in the xtpg_g.c for fixing
MISRA-C files. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/tpg/src/xtpg_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen_v2_1_0.tcl <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a srt
01/20/13 First release 1.01a adk 03/09/13 Updated tcl to differentiate Different
Modes in AXI Traffic Genrator. 3.0 adk 12/10/13 Updated as per the New Tcl API's
4.1 sk 11/09/15 Removed delete filename statement CR 784758. 4.2 ms 04/18/17
Modified tcl file to add suffix U for all macros definitions of trafgen in
xparameters.h </pre> uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/trafgen/data/trafgen.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen_interrupt_example.c
This file demonstrates how to use the xtrafgen driver on the Xilinx AXI Traffic
Generator core. The AXI Traffic Generator IP is designed to generate AXI4
traffic which can be used to stress different modules/ interconnect connected in
the system. It has three internal RAMS: MASTER RAM, COMMAND RAM, PARAMETER RAM.
MASTER RAM is used to load/store data from this memory for write/read
transactions. And the commands to be issued are loaded into COMMAND and
PARAMETER RAMs. This example demonstrates by programming known data to Master
RAM and commands to Command and Param RAM. Initiating the master logic will take
the data from Master RAM (from a location) and generate data for slave
transactions which will be stored in Master RAM at a different location
specified by commands. The test passes when the master logic interrupt asserts
and verifies for data to be same. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a srt 01/25/13 First release 4.1 ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/trafgen/examples/xtrafgen_interrupt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xtrafgen_master_streaming_example.c This file demonstrates how to use the
xtrafgen driver on the Xilinx AXI Traffic Generator core. The AXI Traffic
Generator IP is designed to generate AXI4 traffic which can be used to stress
different modules/ interconnect connected in the system. This example
demonstrates how to use Streaming mode in Axi Traffic Genrator When Configured
in Master only mode.In this mode the core generates Streaming Traffic based on
the transfer length and transfer count configured. To test this example hardware
Must contain a Streaming FIFO and the Connections To Axi TrafficGen needs to
made As shown below ________________ ____________ _________|AXI_STR_RXD | | | |
| | | |_____| | | | axi_master| |________________| |____________| Axi TrafficGen
Axi Stream FIFO <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.01a adk 03/09/13 First release 2.00a adk 16/09/13 Fixed CR:737291
2.01a adk 15/11/13 Fixed CR:760808 4.1 ms 01/23/17 Modified xil_printf statement
in main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. ms 04/05/17 Added
tabspace for return statements in functions for proper documentation while
generating doxygen and also modified filename tag to include the file in doxygen
examples. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/trafgen/examples/xtrafgen_master_streaming_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen_polling_example.c This
file demonstrates how to use the xtrafgen driver on the Xilinx AXI Traffic
Generator core. The AXI Traffic Generator IP is designed to generate AXI4
traffic which can be used to stress different modules/ interconnect connected in
the system. It has three internal RAMS: MASTER RAM, COMMAND RAM, PARAMETER RAM.
MASTER RAM is used to load/store data from this memory for write/read
transactions. And the commands to be issued are loaded into COMMAND and
PARAMETER RAMs. This example demonstrates by programming known data to Master
RAM and commands to Command and Param RAM. Initiating the master logic will take
the data from Master RAM (from a location) and generate data for slave
transactions which will be stored in Master RAM at a different location
specified by commands. The test passes when the master logic completes and
verifies for data to be same. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a srt 01/25/13 First release 4.1 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028. ms
04/05/17 Added tabspace for return statements in functions for proper
documentation while generating doxygen. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/trafgen/examples/xtrafgen_polling_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen_static_mode_example.c
This file demonstrates how to use the xtrafgen driver on the Xilinx AXI Traffic
Generator core. The AXI Traffic Generator IP is designed to generate AXI4
traffic which can be used to stress different modules/ interconnect connected in
the system. This example demonstrates how to use the Static mode in the Axi
Traffic Genrator.In Static mode the core continuously generates fixed address
and fixed INCR type read and write transfers based on the burst length
configured. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.01a adk 03/09/13 First release 2.00a adk 16/09/13 Fixed CR:737291 4.1 ms
01/23/17 Modified xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 04/05/17 Added tabspace for return statements in functions
for proper documentation while generating doxygen. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/trafgen/examples/xtrafgen_static_mode_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen.c @addtogroup
trafgen_v4_2 @{ This file implements AXI Traffic Generator device-wise
initialization and control functions. For more information on the implementation
of this driver, see xtrafgen.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a srt 01/24/13 First release 1.01a adk 03/09/13 Updated
driver to Support Static and Streaming mode. 2.00a adk 16/09/13 Fixed CR:737291
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/trafgen/src/xtrafgen.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen.h @addtogroup
trafgen_v4_2 @{ @details This file contains the implementation of the AXI
Traffic Generator driver. User documentation for the driver functions is
contained in this file in the form of comment blocks at the front of each
function. The AXI Traffic Generator IP is designed to generate AXI4 traffic
which can be used to stress different modules/interconnect connected in the
system. Different configurable options allow the user to generate a wide variety
of traffic based on their requirements. The core is broadly separated into a
master and slave block, each of which contains the write block and read block.
Other support features are provided by the Control registers and Internal RAMs.
The commands to be issued by the AXI traffic generator are loaded in a 128-bit
wide, 512 deep command RAM through AXI Slave interface. After the core is
enabled, control logic issues the write/read commands based on the command
settings programmed. The core updates the Status registers and asserts
interrupts on the completion of issuing programmed commands. The Axi Traffic
Genrator has five different modes: - Advanced Mode: Advanced Mode allows full
control over the traffic generation Control registers are provided to you to
program the core to generate different AXI4 transactions. - Basic Mode: Basic
Mode allows basic AXI4 traffic generation with less resource overhead. - Static
Mode: Static Mode allows you to generate a simple AXI4 traffic with very less
resource and minimum processor intervention.In this Mode the core continuously
generates fixed address and fixed length INCR type read and write transfers. -
System Init Mode: System Init Mode is a special Mode where core provides only
AXI4-Lite Master write interface.This mode can be used in a system without a
processor to initialize the system peripherals with preconfigured values on
system reset. - Streaming Mode: In Streaming Mode the core can be configured to
generate traffic based on the register configuration. <b>Initialization &
Configuration</b> The XTrafGen_Config structure is used by the driver to
configure itself. This configuration structure is typically created by the tool-
chain based on HW build properties. To support multiple runtime loading and
initialization strategies employed by various operating systems, the driver
instance can be initialized in the following way: -
XTrafGen_LookupConfig(DeviceId) - Use the divide identifier to find the static
configuration structure defined in xtrafgen_g.c. This is setup by the tools. For
some operating systems the config structure will be initialized by the software
and this call is not needed. - XTrafGen_CfgInitialize(InstancePtr, CfgPtr,
EffectiveAddr) - Uses a configuration structure provided by the caller. If
running in a system with address translation, the provided virtual memory base
address replaces the physical address present in the configuration structure.
<b>Command Handling</b> AXI Traffic Generator core operates based on the
commands programmed into Command and Parameter RAMs. The CMDRAM and PARAMRAM is
divided into two regions: write and read. Each region can hold 256 entries. Once
the core is enabled, the internal control logic issues write/read commands. To
handle command programming efficiently, we are maintaining a software list of
commands. Following APIs are provided to handle this mechanism: -
XTrafGen_AddCommand(): This function prepares the Command Words and Parameter
Word from the Command structure passed from the user application. It then adds
to a software list of commands. - XTrafGen_WriteCmdsToHw(): This function writes
the prepared list of Command and Parameter Words prepared to CMDRAM and
PARAMRAM. - XTrafGen_GetLastValidIndex(): This function gets last Valid Command
Index of Write/Read region. The last valid command index is used to set
'my_depend' and 'other_depend' fields of the Command RAM. -
XTrafGen_EraseAllCommands(): This function clears the list of commands
maintained in software and also updates the respective RAMs. -
XTrafGen_PrintAllCmds(): This function displays the list of commands. <b>Master
RAM Handling</b> AXI Traffic Generator uses MSTRAM to - Take data from this RAM
for write transactions - Store data to this RAM for read transaction User need
to call this API to write/read to/from Master RAM, - XTrafGen_AccessMasterRam()
- This function programs the Master RAM with the data which is used in master
logic. The amount of the data is limited by the size of master RAM.
<b>Interrupts</b> The driver defaults to no interrupts at initialization such
that interrupts must be enabled if desired. An interrupt is generated for one of
the following conditions: - Master Logic Completion Interrupt - Error Interrupt
(For Master and Slave Errors) The application can control which interrupts are
enabled using these functions: - XTrafGen_EnableMasterCmpInterrupt() -
XTrafGen_MasterErrIntrEnable() - XTrafGen_SlaveErrIntrEnable() The interrupt
system has to be set up and if the interrupts are enabled, Traffic Generator
notifies the software either about the completion or an error in transfer
through interrupts. <b> Examples </b> We provided two examples to show how to
use the driver API: - One for interrupt mode (xtrafgen_interrupt_example.c) -
One for polling mode (xtrafgen_polling_example.c) <b> Asserts </b> Asserts are
used within all Xilinx drivers to enforce constraints on argument values.
Asserts can be turned off on a system-wide basis by defining, at compile time,
the NDEBUG identifier. By default, asserts are turned on and it is recommended
that users leave asserts on during development. <b>RTOS Independence</b> This
driver is intended to be RTOS and processor independent. It works with physical
addresses only. Any needs for dynamic memory management, threads or thread
mutual exclusion, virtual memory, or cache control must be satisfied by the
layer above this driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a srt 01/24/13 First release 1.01a adk 03/09/13 Updated Driver
to Support Streaming and Static Mode 2.00a adk 16/09/13 Fixed CR:737291 2.01a
adk 21/10/13 Fixed CR:740522 Updated the MasterRam offset as per latest IP.This
driver is valid only for IP(v2.0) onwards. The XTG_MASTER_RAM_OFFSET has been
changed from 0x10000 to 0xc000. 2.01a adk 15/11/13 Fixed CR:760808 added Macro's
for the New bit fields added in the latest tarfgen IP(v2.0). 3.0 adk 12/10/13
Updated as per the New Tcl API's 3.1 adk 28/04/14 Fixed CR:782131 Incorrect mask
value for the loopenable bit. 3.2 adk 05/08/14 Fixed CR:798742 The last word of
8KB Master RAM in axi traffic generator can't access and CR:799554 Some
incorrect parameter in axi traffic generator driver. 4.0 sd 19/08/15 Fixed
CR:876564 Added 64-bit Support to axi traffic generator driver. 4.1 ms 01/23/17
Modified xil_printf statement in main function for all examples to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. ms 03/17/17 Added readme.txt file in examples folder for
doxygen generation. ms 04/05/17 Added tabspace for return statements in
functions of trafgen examples for proper documentation while generating doxygen
and also modified filename tag in master streaming example file to include it in
doxygen examples. 4.2 ms 04/18/17 Modified tcl file to add suffix U for all
macros definitions of trafgen in xparameters.h </pre>

FILES:
XilinxProcessorIPLib/drivers/trafgen/src/xtrafgen.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen_g.c @addtogroup
trafgen_v4_2 @{ Provide a template for user to define their own hardware
settings. If using XPS, this file will be automatically generated. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a srt
01/24/13 First release 1.01a adk 03/09/13 Updated driver to Support Static and
Streaming mode. 2.00a adk 16/09/13 Fixed CR:737291 </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/trafgen/src/xtrafgen_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen_hw.h @addtogroup
trafgen_v4_2 @{ This header file contains identifiers and macros that can be
used to access the Axi Traffic Generator device. The driver APIs/functions are
defined in xtrafgen.h. @note <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a srt 1/12/13 First release 1.01a adk 03/09/13 Updated
Driver to Support Static and Streaming Mode 2.00a adk 16/09/13 Fixed CR:737291
2.01a adk 21/10/13 Fixed CR:740522 Updated the MasterRam offset as per latest
IP.This driver is valid only for IP(v2.0) onwards. The XTG_MASTER_RAM_OFFSET has
been changed from 0x10000 to 0xc000. 2.01a adk 15/11/13 Fixed CR:760808 Added
Mask for the New bit field added (XTG_MCNTL_LOOPEN_MASK). 3.1 adk 28/04/14 Fixed
CR:782131 Incorrect Mask value for the loopenable bit. </pre>

FILES:
XilinxProcessorIPLib/drivers/trafgen/src/xtrafgen_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtrafgen_sinit.c @addtogroup
trafgen_v4_2 @{ This file contains static initialization functionality for Axi
Traffic Generator driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a srt 01/24/13 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/trafgen/src/xtrafgen_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a sdm 01/20/12 Initialize release 2.0 adk
12/10/13 Updated as per the New Tcl API's 3.1 sk 11/09/15 Removed delete
filename statement CR 784758. 3.4 ms 04/18/17 Modified tcl file to add suffix U
for all macros definitions of ttcps in xparameters.h uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/ttcps/data/ttcps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 3.0 pkp 12/01/15 Initial Release Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/ttcps/data/ttcps_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_intr_example.c This file
contains a example using two timer counters in the Triple Timer Counter (TTC)
module in the Ps block in interrupt mode. The example proceeds using
interleaving interrupt handling from both timer counters. One timer counter,
Ticker, counts how many interrupts has occurred to it, and updates a flag for
another timer counter upon a given threshold. Another timer counter, PWM, waits
for the flag set from the Ticker, and increases its duty cycle. When the duty
cycle of PWM reaches 100, the example terminates. @note The example may take
seconds to minutes to finish. A small setting of PWM_DELTA_DUTY gives a long
running time, while a large setting makes the example finishes faster. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- ------ -------- 1.00 drg/jz
01/23/10 First release 3.01 pkp 01/30/16 Modified SetupTimer to remove
XTtcps_Stop before TTC configuration as it is added in xttcps.c in
XTtcPs_CfgInitialize 3.2 mus 10/28/16 Updated TmrCntrSetup as per prototype of
XTtcPs_CalcIntervalFromFreq 3.10 mus 05/20/19 Update example to make it generic
to run on any intended TTC device aru 05/30/19 Updated the exapmle to use
XTtcPs_InterruptHandler(). </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/examples/xttcps_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_low_level_example.c This
file contains a design example using the Triple Timer Counter hardware and
driver in polled mode. The example generates a square wave output on the
waveform out pin. @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- ------ -------- 1.00 drg/jz 01/23/10 First release 3.0 pkp 12/09/14 Change
TTC_NUM_DEVICES for Zynq Ultrascale MP support 3.9 mus 04/09/19 Updated
SettingsTable values as per TmrCntrSetup template </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/examples/xttcps_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_rtc_example.c This
example uses one timer/counter to make a real time clock. The number of minutes
and seconds is displayed on the console. @note <pre> MODIFICATION HISTORY: Ver
Who Date Changes ---- ------ -------- 1.00 drg/jz 01/23/10 First release 3.01
pkp 01/30/16 Modified SetupTimer to remove XTtcps_Stop before TTC configuration
as it is added in xttcps.c in XTtcPs_CfgInitialize 3.2 mus 10/28/16 Updated
TmrCntrSetup as per prototype of XTtcPs_CalcIntervalFromFreq ms 01/23/17
Modified xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
3.10 aru 05/30/19 Updated the example to use XTtcPs_InterruptHandler(). </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/examples/xttcps_rtc_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_tapp_example.c This file
contains an example uses ttc to generate interrupt and update a flag which is
checked in interrupt example to confirm whether the interrupt is generated or
not. @note <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ------ --------
3.00 pkp 01/12/15 First release 3.01 pkp 01/30/16 Modified SetupTimer to remove
XTtcps_Stop before TTC configuration as it is added in xttcps.c in
XTtcPs_CfgInitialize 3.01 pkp 03/04/16 Added status check after SetupTicker is
called by TmrInterruptExample 3.2 mus 10/28/16 Updated TmrCntrSetup as per
prototype of XTtcPs_CalcIntervalFromFreq ms 01/23/17 Modified xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. 3.10 aru
05/30/19 Updated the example to use XTtcPs_InterruptHandler(). </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/examples/xttcps_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps.c @addtogroup
ttcps_v3_10 @{ This file contains the implementation of the XTtcPs driver. This
driver controls the operation of one timer counter in the Triple Timer Counter
(TTC) module in the Ps block. Refer to xttcps.h for more detailed description of
the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a drg/jz 01/21/10 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. 3.01 pkp 01/30/16 Modified XTtcPs_CfgInitialize to add
XTtcps_Stop to stop the timer before configuring 3.2 mus 10/28/16 Modified
XTtcPs_CalcIntervalFromFreq to calculate 32 bit interval count for zynq
ultrascale+mpsoc 3.5 srm 10/06/17 Updated XTtcPs_GetMatchValue and
XTtcPs_SetMatchValue APIs to use correct match register width for zynq (i.e. 16
bit) and zynq ultrascale+mpsoc (i.e. 32 bit). It fixes CR 986617 3.6 srm
04/25/18 Corrected the Match register initialization in XTtcPs_CfgInitialize
API. 3.7 mus 09/20/18 Modified XTtcPs_CalcIntervalFromFreq API to use
XTTCPS_MAX_INTERVAL_COUNT instead of hardcoding MAX interval count to 16 bit
value(i.e.65532), which is incorrect for zynq ultrascale+mpsoc (i.e. max
interval count is 32 bit). 3.10 aru 05/06/19 Added assert check for driver
instance and freq parameter in XTtcPs_CalcIntervalFromFreq(). 3.10 aru 05/30/19
Added interrupt handler to clear ISR </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/src/xttcps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps.h @addtogroup
ttcps_v3_10 @{ @details This is the driver for one 16-bit timer counter in the
Triple Timer Counter (TTC) module in the Ps block. The TTC module provides three
independent timer/counter modules that can each be clocked using either the
system clock (pclk) or an externally driven clock (ext_clk). In addition, each
counter can independently prescale its selected clock input (divided by 2 to
65536). Counters can be set to decrement or increment. Each of the counters can
be programmed to generate interrupt pulses: . At a regular, predefined period,
that is on a timed interval . When the counter registers overflow . When the
count matches any one of the three 'match' registers Therefore, up to six
different events can trigger a timer interrupt: three match interrupts, an
overflow interrupt, an interval interrupt and an event timer interrupt. Note
that the overflow interrupt and the interval interrupt are mutually exclusive.
<b>Initialization & Configuration</b> An XTtcPs_Config structure is used to
configure a driver instance. Information in the XTtcPs_Config structure is the
hardware properties about the device. A driver instance is initialized through
XTtcPs_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr). Where CfgPtr is a
pointer to the XTtcPs_Config structure, it can be looked up statically through
XTtcPs_LookupConfig(DeviceID), or passed in by the caller. The EffectiveAddr can
be the static base address of the device or virtual mapped address if address
translation is supported. <b>Interrupts</b> Interrupt handler is not provided by
the driver, as handling of interrupt is application specific. @note The default
setting for a timer/counter is: - Overflow Mode - Internal clock (pclk) selected
- Counter disabled - All Interrupts disabled - Output waveforms disabled <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a drg/jz
01/20/10 First release.. 2.0 adk 12/10/13 Updated as per the New Tcl API's 3.0
pkp 12/09/14 Added support for Zynq Ultrascale Mp.Also code modified for
MISRA-C:2012 compliance. 3.2 mus 10/28/16 Modified XTtcPs_GetCounterValue and
XTtcPs_SetInterval macros to return 32 bit values for zynq ultrascale+mpsoc ms
01/23/17 Modified xil_printf statement in main function for all examples to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. 3.4 ms 04/18/17 Modified tcl file to add
suffix U for all macros definitions of ttcps in xparameters.h 3.5 srm 10/06/17
Added new typedef XMatchRegValue for match register width 3.8 aru 12/19/18
Modified in XTtcPs_ClearInterruptStatus function to clear Interrupt status
register by reading instead of writing it. </pre>

FILES:
XilinxProcessorIPLib/drivers/ttcps/src/xttcps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_g.c @addtogroup
ttcps_v3_7 @{ This file contains a configuration table where each entry is the
configuration information for one timer counter device in the system. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a drg/jz
01/21/10 First release 2.00 hk 22/01/14 Added check for picking instances other
than default. 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/src/xttcps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_hw.h @addtogroup
ttcps_v3_10 @{ This file defines the hardware interface to one of the three
timer counters in the Ps block. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00a drg/jz 01/21/10 First release 3.00 kvn 02/13/15
Modified code for MISRA-C:2012 compliance. 3.5 srm 10/06/17 Updated
XTTCPS_COUNT_VALUE_MASK, XTTCPS_INTERVAL_VAL_MASK, XTTCPS_MATCH_MASK macros to
mask 16 bit values for zynq and 32 bit values for zynq ultrascale+mpsoc " </pre>

FILES:
XilinxProcessorIPLib/drivers/ttcps/src/xttcps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_options.c @addtogroup
ttcps_v3_10 @{ This file contains functions to get or set option features for
the device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a drg/jz 01/21/10 First release 1.01a nm 03/05/2012 Removed break
statement after return to remove compilation warnings. 3.00 kvn 02/13/15
Modified code for MISRA-C:2012 compliance. 3.10 aru 05/16/19 Removed the
redudant code from XTtcPs_SetOptions(). </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/src/xttcps_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_selftest.c @addtogroup
ttcps_v3_10 @{ This file contains the implementation of self test function for
the XTtcPs driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a drg/jz 01/21/10 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/src/xttcps_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xttcps_sinit.c @addtogroup
ttcps_v3_10 @{ The implementation of the XTtcPs driver's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a drg/jz 01/21/10 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ttcps/src/xttcps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Removed support for
xps_uartlite xps_mdm @BEGIN_CHANGELOG EDK_M 11/18/2009 ktn Removed support for
opb_uartlite opb_jtag_uart opb_mdm @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3
06/16/10 sv Added support for axi_uartlite @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/uartlite/data/uartlite.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 2.00a sdm 06/18/10 Updated to not generate duplicate
canonical definitions when canonical names are same as instance specific names
3.0 adk 12/10/13 Updated as per the New Tcl API's uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/uartlite/data/uartlite.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_I - include header files @END_CHANGELOG
@BEGIN_CHANGELOG EDK_H - Initial Revision @END_CHANGELOG Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/uartlite/data/uartlite_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_intr_example.c This
file contains a design example using the UartLite driver (XUartLite) and
hardware device using the interrupt mode. @note The user must provide a physical
loopback such that data which is transmitted will be received. MODIFICATION
HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.00a jhl 02/13/02 First
release 1.00b rpm 10/01/03 Made XIntc declaration global 1.00b sv 06/09/05 Minor
changes to comply to Doxygen and coding guidelines 2.00a ktn 10/20/09 Updated to
use HAL Processor APIs and minor changes for coding guidelnes. 3.2 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/examples/xuartlite_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_intr_tapp_example.c
This file contains a design example using the UartLite driver and hardware
device using the interrupt mode for transmission of data. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b sv 06/08/06
Created for supporting Test App Interrupt examples 2.00a ktn 10/20/09 Updated to
use HAL Processor APIs and minor changes for coding guidelnes. 2.01a ssb
01/11/01 Updated the example to be used with the SCUGIC in Zynq. 3.2 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/examples/xuartlite_intr_tapp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_low_level_example.c
This file contains a design example using the low-level driver functions and
macros of the UartLite driver (XUartLite). @note The user must provide a
physical loopback such that data which is transmitted will be received.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.00b rpm
04/25/02 First release 1.00b sv 06/13/05 Minor changes to comply to Doxygen and
coding guidelines 2.00a ktn 10/20/09 Updated to use HAL processor APIs and minor
changes for coding guidelines. 3.2 ms 01/23/17 Added xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/examples/xuartlite_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_polled_example.c This
file contains a design example using the UartLite driver (XUartLite) and
hardware device using the polled mode. @note The user must provide a physical
loopback such that data which is transmitted will be received. MODIFICATION
HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.00a jhl 02/13/02 First
release 1.00a sv 06/13/05 Minor changes to comply to Doxygen and coding
guidelines 2.00a ktn 10/20/09 Updated this example to wait for valid data in
receive fifo instead of Tx fifo empty to update receive buffer and minor changes
as per coding guidelines. 3.2 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/examples/xuartlite_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_selftest_example.c
This file contains a design example using the UartLite driver (XUartLite) and
hardware device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 1.00a ecm 01/25/04 First Release. 1.00a sv 06/13/05 Minor
changes to comply to Doxygen and Coding guidelines 2.00a ktn 10/20/09 Minor
changes as per coding guidelines. 3.2 ms 01/23/17 Added xil_printf statement in
main function to ensure that "Successfully ran" and "Failed" strings are
available in all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/examples/xuartlite_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite.c @addtogroup
uartlite_v3_3 @{ Contains required functions for the XUartLite driver. See the
xuartlite.h header file for more details on this driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm 08/31/01 First
release 1.00b jhl 02/21/02 Repartitioned the driver for smaller files 1.00b rmm
05/13/03 Fixed diab compiler warnings relating to asserts 1.01a jvb 12/13/05
Changed Initialize() into CfgInitialize(), and made CfgInitialize() take a
pointer to a config structure instead of a device id. Moved Initialize() into
xgpio_sinit.c, and had Initialize() call CfgInitialize() after it retrieved the
config structure using the device id. Removed include of xparameters.h along
with any dependencies on xparameters.h and the _g.c config table. 1.01a wsy
05/08/06 fix CR220811 and CR224103. 1.12a mta 03/31/07 Updated to new coding
conventions 1.13a sv 01/21/08 Updated driver to support access through DCR bus
1.14a sdm 09/26/08 Updated code to avoid race condition in XUartLite_SendBuffer
2.00a ktn 10/20/09 Updated to use HAL Processor APIs. The macros have been
renamed to remove _m from the name. XUartLite_mClearStats macro is removed and
XUartLite_ClearStats function should be used in its place. 2.00a hvm 08/11/11
Removed the SetOptions related information in the Recv and RecvBuffer function
header notes section. CR620849. 2.01a adk 18/04/13 Updated the code to avoid
unused variable warnings when compiling with the -Wextra -Wall flags In the file
xuartlite.c. CR:704999. 3.1 nsk 21/07/15 Updated XUartLite_ReceiveBuffer
function to update the receive data into user buffer in critical region.
CR865787. 3.2 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425.
Changed the prototype of XUartLite_CfgInitialize API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite.h @addtogroup
uartlite_v3_3 @{ @details This component contains the implementation of the
XUartLite component which is the driver for the Xilinx UART Lite device. This
UART is a minimal hardware implementation with minimal features. Most of the
features, including baud rate, parity, and number of data bits are only
configurable when the hardware device is built, rather than at run time by
software. The device has 16 byte transmit and receive FIFOs and supports
interrupts. The device does not have any way to disable the receiver such that
the receive FIFO may contain unwanted data. The FIFOs are not flushed when the
driver is initialized, but a function is provided to allow the user to reset the
FIFOs if desired. The driver defaults to no interrupts at initialization such
that interrupts must be enabled if desired. An interrupt is generated when the
transmit FIFO transitions from having data to being empty or when any data is
contained in the receive FIFO. In order to use interrupts, it's necessary for
the user to connect the driver interrupt handler, XUartLite_InterruptHandler, to
the interrupt system of the application. This function does not save and restore
the processor context such that the user must provide it. Send and receive
handlers may be set for the driver such that the handlers are called when
transmit and receive interrupts occur. The handlers are called from interrupt
context and are designed to allow application specific processing to be
performed. The functions, XUartLite_Send and XUartLite_Recv, are provided in the
driver to allow data to be sent and received. They are designed to be used in
polled or interrupt modes. The driver provides a status for each received byte
indicating any parity frame or overrun error. The driver provides statistics
which allow visibility into these errors. <b>Initialization & Configuration</b>
The XUartLite_Config structure is used by the driver to configure itself. This
configuration structure is typically created by the tool-chain based on HW build
properties. To support multiple runtime loading and initialization strategies
employed by various operating systems, the driver instance can be initialized in
one of the following ways: - XUartLite_Initialize(InstancePtr, DeviceId) - The
driver looks up its own configuration structure created by the tool-chain based
on an ID provided by the tool-chain. - XUartLite_CfgInitialize(InstancePtr,
CfgPtr, EffectiveAddr) - Uses a configuration structure provided by the caller.
If running in a system with address translation, the provided virtual memory
base address replaces the physical address present in the configuration
structure. <b>RTOS Independence</b> This driver is intended to be RTOS and
processor independent. It works with physical addresses only. Any needs for
dynamic memory management, threads or thread mutual exclusion, virtual memory,
or cache control must be satisfied by the layer above this driver. @note The
driver is partitioned such that a minimal implementation may be used. More
features require additional files to be linked in. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a ecm 08/31/01 First release 1.00b
jhl 02/21/02 Repartitioned the driver for smaller files 1.01a jvb 12/14/05 I
separated dependency on the static config table and xparameters.h from the
driver initialization by moving _Initialize and _LookupConfig to _sinit.c. I
also added the new _CfgInitialize routine. 1.02a rpm 02/14/07 Added check for
outstanding transmission before calling the send callback (avoids extraneous
callback invocations) in interrupt service routine. 1.12a mta 03/31/07 Updated
to new coding conventions 1.13a sv 01/21/08 Updated driver to support access
through DCR bus 1.14a sdm 08/22/08 Removed support for static interrupt handlers
from the MDD file 1.14a sdm 09/26/08 Updated code to avoid race condition in
XUartLite_SendBuffer 2.00a ktn 10/20/09 Updated to use HAL Processor APIs. The
macros have been renamed to remove _m from the name. XUartLite_mClearStats macro
is removed and XUartLite_ClearStats function should be used in its place. 2.01a
adk 18/04/13 Updated the code to avoid unused variable warnings when compiling
with the -Wextra -Wall flags In the file xuartlite.c. CR:704999. Added notes for
CR 710483 that the XUL_FIFO_SIZE is not used in the driver. This is the size of
the FIFO for Transmit/Receive FIFOs which cannot be changed. 3.0 adk 17/12/13
Fixed CR:741186,761863 Changes are made in the file xuartlite_selftest.c 3.0 adk
19/12/13 Update the driver as per new TCL API's 3.1 nsk 21/07/15 Updated
XUartLite_ReceiveBuffer function in xuartlite.c to update the receive data into
user buffer in critical region.CR865787. 3.2 sk 11/10/15 Used UINTPTR instead of
u32 for Baseaddress CR 867425. Changed the prototype of XUartLite_CfgInitialize
API. ms 01/23/17 Added xil_printf statement in main function for all examples to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_g.c @addtogroup
uartlite_v3_3 @{ This file contains a configuration table that specifies the
configuration of UART Lite devices in the system. Each device in the system
should have an entry in the table. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a ecm 08/31/01 First release 1.00b jhl 02/21/02
Repartitioned the driver for smaller files </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_i.h @addtogroup
uartlite_v3_3 @{ Contains data which is shared between the files of the
XUartLite component. It is intended for internal use only. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm 08/31/01 First
release 1.00b jhl 02/21/02 Reparitioned the driver for smaller files 1.00b rpm
04/24/02 Moved register definitions to xuartlite_l.h and updated macro naming
convention 2.00a ktn 10/20/09 The macros have been renamed to remove _m from the
name. XUartLite_mClearStats macro is removed and XUartLite_ClearStats function
should be used in its place. </pre>

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_intr.c @addtogroup
uartlite_v3_3 @{ This file contains interrupt-related functions for the UART
Lite component (XUartLite). <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a ecm 08/31/01 First release 1.00b jhl 02/21/02
Repartitioned the driver for smaller files 1.02a rpm 02/14/07 Added check for
outstanding transmission before calling the send callback (avoids extraneous
callback invocations) 2.00a ktn 10/20/09 Updated to use HAL Processor APIs. The
macros have been renamed to remove _m from the name. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_l.c @addtogroup
uartlite_v3_3 @{ This file contains low-level driver functions that can be used
to access the device. The user should refer to the hardware device specification
for more details of the device operation. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00b rpm 04/25/02 First release 1.12a rpm
07/16/07 Fixed arg type for RecvByte 2.00a ktn 10/20/09 The macros have been
renamed to remove _m from the name. 3.2 sk 11/10/15 Used UINTPTR instead of u32
for Baseaddress CR 867425. Changed the prototypes of XUartLite_SendByte,
XUartLite_RecvByte APIs. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_l.h @addtogroup
uartlite_v3_3 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. High-level driver
functions are defined in xuartlite.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00b rpm 04/25/02 First release 1.00b rpm 07/07/03
Removed references to XUartLite_GetControlReg macro since the control register
is write-only 1.12a mta 03/21/07 Updated to new coding style 1.13a sv 01/21/08
Updated driver to support access through DCR bus 2.00a ktn 10/20/09 Updated to
use HAL Processor APIs. The macros have been renamed to remove _m from the name.
3.2 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed
the prototypes of XUartLite_SendByte, XUartLite_RecvByte APIs. </pre>

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_selftest.c
@addtogroup uartlite_v3_3 @{ This file contains the self-test functions for the
UART Lite component (XUartLite). <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a ecm 08/31/01 First release 1.00b jhl 02/21/02
Repartitioned the driver for smaller files 2.00a ktn 10/20/09 Updated to use HAL
Processor APIs. The macros have been renamed to remove _m from the name. 3.0 adk
17/12/13 Fixed CR:741186,761863 Reset the FIFO's before reading the status
register We don't know the status of the Status Register in case of if there is
more than one uartlite IP instance in the h/w design. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_sinit.c @addtogroup
uartlite_v3_3 @{ The implementation of the XUartLite component's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.01a jvb 10/13/05 First release 2.00a ktn 10/20/09 Updated
to use HAL Processor APIs. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartlite_stats.c @addtogroup
uartlite_v3_3 @{ This file contains the statistics functions for the UART Lite
component (XUartLite). <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a ecm 08/31/01 First release 1.00b jhl 02/21/02 Repartitioned
the driver for smaller files 2.00a ktn 10/20/09 Updated to use HAL Processor
APIs. XUartLite_mClearStats macro is removed. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartlite/src/xuartlite_stats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Removed support for
xps_uart16550 @BEGIN_CHANGELOG EDK_L Deprecated the CLOCK_HZ parameter in mdd
and updated the Tcl to obtain the bus frequency during libgen. @END_CHANGELOG
@BEGIN_CHANGELOG EDK_M 17/11/09 ktn removed support for opb_uart16550
plb_uart16550 @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3 06/16/10 sv Added support
for axi_uart16550 @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/uartns550/data/uartns550.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's 3.1 adk 20/08/14 Fixed CR:816989 Canonical Definition for Multiple
Instances of UARTSNS550 have the same Device Id. 3.2 adk 15/10/14 Fixed
CR:826435 external clock speed is not being updated with proper value in
xparametrs.h file. 3.4 sk 11/09/15 Removed delete filename statement CR 784758.
3.5 ms 04/18/17 Modified tcl file to add suffix U for all macros definitions of
uartns550 in xparameters.h @BEGIN_CHANGELOG EDK_L Deprecated the CLOCK_HZ
parameter in mdd and updated the Tcl to obtain the bus frequency during libgen.
@END_CHANGELOG @BEGIN_CHANGELOG EDK_LS3 Updated to obtain external clock
frequency from either the port "xin" or the new parameter C_EXTERNAL_XIN_CLK_HZ
(if frequecy can't be read from xin) when C_HAS_EXTERNAL_XIN is set to 1
@END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/uartns550/data/uartns550.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_M 19/11/09 ktn Replaced the call to
XUartNs550_mSetLineControlReg with a call to XUartNs550_SetLineControlReg as the
name of these macros has changed. @END_CHANGELOG @BEGIN_CHANGELOG EDK_Im_SP2 -
Added Interrupt support @END_CHANGELOG @BEGIN_CHANGELOG EDK_I - include header
files @END_CHANGELOG @BEGIN_CHANGELOG EDK_H - Added support for generation of
multiple applications. All TCL procedures are now required to have a software
project type as its first argument @END_CHANGELOG Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/uartns550/data/uartns550_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xuartns550_hello_world_example.c This file contains a design example using the
Uart 16450/550 driver (XUartNs550) and hardware device using polled mode. @note
None. MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 1.00a
jhl 05/13/02 First release 1.00a sv 06/08/05 Minor changes to comply to Doxygen
and coding guidelines 2.00a ktn 10/20/09 Updated to use HAL processor APIs and
minor modifications as per coding guidelines. 3.4 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/examples/xuartns550_hello_world_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_intr_example.c This
file contains a design example using the UART 16450/16550 driver (XUartNs550)
and hardware device using interrupt mode. @note <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00b jhl 02/13/02 First release 1.00b sv
06/08/05 Minor changes to comply to Doxygen and coding guidelines 1.01a sv
05/08/06 Minor changes for supporting Test App Interrupt examples 2.00a ktn
10/20/09 Updated to use HAL processor APIs and minor modifications as per coding
guidelines. 2.01a ssb 01/11/01 Updated the example to be used with the SCUGIC in
Zynq. 3.2 adk 15/10/14 Clear the global counters.If multiple instance of ip is
present in the h/w design without clearing these counters will result undefined
behaviour for the second ip instance while running the peripheral tests. 3.4 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/examples/xuartns550_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_low_level_example.c
This file contains a design example using the low-level driver functions and
macros of the UART NS550 driver. @note None. MODIFICATION HISTORY: <pre> Ver Who
Date Changes ----- ---- -------- 1.00b rpm 04/25/02 First release 1.00b sv
06/08/05 Minor changes to comply to Doxygen and coding guidelines 2.00a ktn
10/20/09 Updated to use HAL processor APIs, minor modifications as per coding
guidelines and macros have been renamed to remove _m from the name. 3.4 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/examples/xuartns550_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_polled_example.c
This file contains a design example using the Uart 16450/550 driver (XUartNs550)
and hardware device using polled mode. MODIFICATION HISTORY: <pre> Ver Who Date
Changes ----- ---- -------- 1.00a jhl 02/13/02 First release 1.00b ecm 01/25/05
Modified for TestApp integration, updated boilerplate. 1.00b sv 06/08/05 Minor
changes to comply to Doxygen and coding guidelines 2.00a ktn 10/20/09 Updated to
use HAL processor APIs and minor modifications as per coding guidelines. Updated
this example to wait for valid data in receive fifo instead of Tx fifo empty to
update receive buffer 3.4 ms 01/23/17 Added xil_printf statement in main
function to ensure that "Successfully ran" and "Failed" strings are available in
all examples. This is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/examples/xuartns550_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_selftest_example.c
This file contains a design example using the Uart 16450/550 driver (XUartNs550)
and hardware device using polled mode. @note None MODIFICATION HISTORY: <pre>
Ver Who Date Changes ----- ---- -------- 1.00a sv 10/07/05 Created for Test App
integration 2.00a ktn 10/20/09 Updated to use HAL processor APIs and minor
modifications as per coding guidelines. 3.4 ms 01/23/17 Added xil_printf
statement in main function to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/examples/xuartns550_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550.c @addtogroup
uartns550_v3_5 @{ This file contains the required functions for the 16450/16550
UART driver. Refer to the header file xuartns550.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ecm 08/16/01 First release 1.00b jhl 03/11/02 Repartitioned
driver for smaller files. 1.00b rmm 05/14/03 Fixed diab compiler warnings
relating to asserts. 1.01a jvb 12/13/05 I changed Initialize() into
CfgInitialize(), and made CfgInitialize() take a pointer to a config structure
instead of a device id. I moved Initialize() into xgpio_sinit.c, and had
Initialize() call CfgInitialize() after it retrieved the config structure using
the device id. I removed include of xparameters.h along with any dependencies on
xparameters.h and the _g.c config table. 1.11a sv 03/20/07 Updated to use the
new coding guidelines. 2.00a ktn 10/20/09 Converted all register accesses to 32
bit access. Updated to use HAL Processor APIs. _m is removed from the name of
all the macro definitions. XUartNs550_mClearStats macro is removed,
XUartNs550_ClearStats function should be used in its place. 2.01a bss 01/13/12
Removed unnecessary read of the LCR register in the XUartNs550_CfgInitialize
function. Removed compiler warnings for unused variables in the
XUartNs550_StubHandler. 3.3 nsk 04/13/15 Fixed Clock Divisor Enhancement. (CR
857013) 3.4 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425.
Changed the prototype of XUartNs550_CfgInitialize API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550.h @addtogroup
uartns550_v3_5 @{ @details This driver supports the following features in the
Xilinx 16450/16550 compatible UART. - Dynamic data format (baud rate, data bits,
stop bits, parity) - Polled mode - Interrupt driven mode - Transmit and receive
FIFOs (16 bytes each for the 16550) - Access to the external modem control lines
and the two discrete outputs The only difference between the 16450 and the 16550
is the addition of transmit and receive FIFOs in the 16550. <b>Initialization &
Configuration</b> The XUartNs550_Config structure is used by the driver to
configure itself. This configuration structure is typically created by the tool-
chain based on HW build properties. To support multiple runtime loading and
initialization strategies employed by various operating systems, the driver
instance can be initialized in one of the following ways: -
XUartNs550_Initialize(InstancePtr, DeviceId) - The driver looks up its own
configuration structure created by the tool-chain based on an ID provided by the
tool-chain. - XUartNs550_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) -
Uses a configuration structure provided by the caller. If running in a system
with address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <b>Baud Rate</b> The
UART has an internal baud rate generator that is clocked at a specified input
clock frequency. Not all baud rates can be generated from some clock
frequencies. The requested baud rate is checked using the provided clock for the
system, and checked against the acceptable error range. An error may be returned
from some functions indicating the baud rate was in error because it could not
be generated. <b>Interrupts</b> The device does not have any way to disable the
receiver such that the receive FIFO may contain unwanted data. The FIFOs are not
flushed when the driver is initialized, but a function is provided to allow the
user to reset the FIFOs if desired. The driver defaults to no interrupts at
initialization such that interrupts must be enabled if desired. An interrupt is
generated for any of the following conditions. - Transmit FIFO is empty - Data
in the receive FIFO equal to the receive threshold - Data in the receiver when
FIFOs are disabled - Any receive status error or break condition detected - Data
in the receive FIFO for 4 character times without receiver activity - A change
of a modem signal The application can control which interrupts are enabled using
the SetOptions function. In order to use interrupts, it is necessary for the
user to connect the driver interrupt handler, XUartNs550_InterruptHandler(), to
the interrupt system of the application. This function does not save and restore
the processor context such that the user must provide it. A handler must be set
for the driver such that the handler is called when interrupt events occur. The
handler is called from interrupt context and is designed to allow application
specific processing to be performed. The functions, XUartNs550_Send() and
XUartNs550_Recv(), are provided in the driver to allow data to be sent and
received. They are designed to be used in polled or interrupt modes. @note The
default configuration for the UART after initialization is: - 19,200 bps or
XPAR_DEFAULT_BAUD_RATE if defined - 8 data bits - 1 stop bit - no parity -
FIFO's are enabled with a receive threshold of 8 bytes <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm 08/16/01 First
release 1.00b jhl 03/11/02 Repartitioned the driver for smaller files. 1.01a jvb
12/14/05 I separated dependency on the static config table and xparameters.h
from the driver initialization by moving _Initialize and _LookupConfig to
_sinit.c. I also added the new _CfgInitialize routine. 1.11a sv 03/20/07 Updated
to use the new coding guidelines. 1.11a sv 07/25/08 Corrected the definitions of
XUN_MODEM_DCD_DELTA_MASK and XUN_MODEM_DCD_MASK. 1.12a sdm 08/22/08 Removed
support for static interrupt handlers from the MDD file 1.12a sdm 12/15/08
Deprecated the CLOCK_HZ parameter in mdd and updated the Tcl to obtain the bus
frequency during libgen 1.13a sdm 07/10/09 a) Updated the driver Tcl to obtain
the external clock frequency from MHS, when C_HAS_EXTERNAL_XIN 1. b) Added
receive line interrupt option to OptionsTable[] in xuartns550_options.c 2.00a
ktn 10/20/09 Converted all register accesses to 32 bit access. Updated to use
HAL Processor APIs. _m is removed from the name of all the macro definitions.
XUartNs550_mClearStats macro is removed, XUartNs550_ClearStats function should
be used in its place. 2.01a bss 01/13/12 Updated the XUartNs550_SelfTest to use
Xil_AssertNonvoid in place of XASSERT_NONVOID for CR 641344. Removed unnecessary
read of the LCR register in the XUartNs550_CfgInitialize function. Removed
compiler warnings for unused variables in the XUartNs550_StubHandler. 2.02a adk
09/16/13 Fixed CR:735289 changes are made in the xuartns550_intr.c file. 3.0 adk
19/12/13 Updated as per the New Tcl API's 3.1 adk 20/08/14 Fixed CR:816989
Canonical Definition for Multiple Instances of UARTSNS550 have the same Device
Id. Changes are made in the driver tcl file. 3.2 adk 15/10/14 Fixed CR:824444
changes are made in the example file xuartns550_intr_example.c. 3.2 adk 15/10/14
Fixed CR:826435 changes are made in the driver tcl file. 3.3 nsk 04/13/15 Fixed
CR:857013 changes are made in xuartns550.c and xuartns550_l.c. 3.4 sk 11/10/15
Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototype of
XUartNs550_CfgInitialize API. ms 01/23/17 Added xil_printf statement in main
function for all examples to ensure that "Successfully ran" and "Failed" strings
are available in all examples. This is a fix for CR-965028. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. 3.5 ms 04/18/17
Modified tcl file to add suffix U for all macros definitions of uartns550 in
xparameters.h </pre>

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_format.c @addtogroup
uartns550_v3_5 @{ This file contains the data format functions for the
16450/16550 UART driver. The data format functions allow the baud rate, number
of data bits, number of stop bits and parity to be set and retrieved. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
03/11/02 Repartitioned driver for smaller files. 1.00b rmm 05/15/03 Fixed diab
compiler warnings. 1.11a sv 03/20/07 Updated to use the new coding guidelines.
2.00a ktn 10/20/09 Converted all register accesses to 32 bit access. Updated to
use HAL Processor APIs. _m is removed from the name of all the macro
names/definitions. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_format.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_g.c @addtogroup
uartns550_v3_5 @{ This file contains a configuration table that specifies the
configuration of NS16550 devices in the system. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a ecm 08/16/01 First release 1.00b jhl
03/11/02 Repartitioned driver for smaller files. 1.11a sv 03/20/07 Updated to
use the new coding guidelines. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_i.h @addtogroup
uartns550_v3_5 @{ This header file contains internal identifiers, which are
those shared between the files of the driver. It is intended for internal use
only. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
ecm 08/16/01 First release 1.00b jhl 03/11/02 Repartitioned driver for smaller
files. 1.11a sv 03/20/07 Updated to use the new coding guidelines. 2.00a ktn
10/20/09 Converted all register accesses to 32 bit access. Updated to use HAL
Processor APIs. _m is removed from the name of all the macro definitions.
XUartNs550_mClearStats macro is removed, XUartNs550_ClearStats function should
be used in its place. </pre>

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_intr.c @addtogroup
uartns550_v3_5 @{ This file contains the functions that are related to interrupt
processing for the 16450/16550 UART driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00b jhl 03/11/02 Repartitioned driver for
smaller files. 1.11a sv 03/20/07 Updated to use the new coding guidelines. 2.00a
ktn 10/20/09 Converted all register accesses to 32 bit access. Updated to use
HAL Processor APIs. _m is removed from the name of all the macro definitions.
XUartNs550_mClearStats macro is removed, XUartNs550_ClearStats function should
be used in its place. 2.02a adk 09/16/13 Updated the ReceiveDataHandler function
to be the same as ReceiveTimeoutHandler. The ReceiveTimeoutHandler will call the
callback function with XUN_EVENT_RECV_TIMEOUT when there is data received which
is less than the requested data (this will also happen for the case where the
data is equal to the threshold). The callback function with XUN_EVENT_RECV_DATA
will be called when all the requested data has been received </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_l.c @addtogroup
uartns550_v3_5 @{ This file contains low-level driver functions that can be used
to access the device. The user should refer to the hardware device specification
for more details of the device operation. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00b jhl 04/24/02 First release 1.11a sv
03/20/07 Updated to use the new coding guidelines. 2.00a sdm 09/22/09 Converted
all register accesses to 32 bit access. 2.00a ktn 10/20/09 Converted all
register accesses to 32 bit access. Updated to use HAL Processor APIs. _m is
removed from the name of all the macro definitions. 3.3 nsk 04/13/15 Fixed Clock
Divisor Enhancement. (CR 857013) 3.4 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototypes of XUartNs550_SendByte,
XUartNs550_RecvByte, XUartNs550_SetBaud APIs. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_l.h @addtogroup
uartns550_v3_5 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. The user should
refer to the hardware device specification for more details of the device
operation. High-level driver functions are defined in xuartns550.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
04/24/02 First release 1.11a sv 03/20/07 Updated to use the new coding
guidelines. 1.11a rpm 11/13/07 Fixed bug in _EnableIntr 2.00a ktn 10/20/09
Converted all register accesses to 32 bit access. Updated to use HAL Processor
APIs. _m is removed from the name of all the macro definitions. 3.4 sk 11/10/15
Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototypes of
XUartNs550_SendByte, XUartNs550_RecvByte, XUartNs550_SetBaud APIs. </pre>

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_options.c
@addtogroup uartns550_v3_5 @{ The implementation of the options functions for
the XUartNs550 driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00b jhl 03/11/02 Repartitioned driver for smaller files. 1.00b
rpm 04/12/05 Added critical section protection in ReadFcrRegister 1.11a sv
03/20/07 Updated to use the new coding guidelines. 1.13a sdm 07/10/09 Added
receive line interrupt option to OptionsTable[]. 2.00a sdm 09/22/09 Converted
all register accesses to 32 bit access. 2.00a ktn 10/20/09 Converted all
register accesses to 32 bit access. Updated to use HAL Processor APIs. _m is
removed from the name of all the macro definitions. 3.4 sk 11/10/15 Used UINTPTR
instead of u32 for Baseaddress CR 867425. Changed the prototype of
ReadFcrRegister API. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_selftest.c
@addtogroup uartns550_v3_5 @{ This file contains the self-test functions for the
16450/16550 UART driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a ecm 08/16/01 First release 1.00b jhl 03/11/02 Repartitioned
driver for smaller files. 1.11a sv 03/20/07 Updated to use the new coding
guidelines. 2.00a ktn 10/20/09 Converted all register accesses to 32 bit access.
Updated to use HAL Processor APIs. _m is removed from the name of all the macro
definitions. 2.01a bss 01/13/12 Updated the XUartNs550_SelfTest to use
Xil_AssertNonvoid in place of XASSERT_NONVOID for CR 641344. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_sinit.c @addtogroup
uartns550_v3_5 @{ The implementation of the XUartNs550 component's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.01a jvb 10/13/05 First release 1.11a sv 03/20/07 Updated
to use the new coding guidelines. 2.00a ktn 10/20/09 Updated to use HAL
Processor APIs. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartns550_stats.c @addtogroup
uartns550_v3_5 @{ This file contains the statistics functions for the
16450/16550 UART driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a ecm 08/16/01 First release 1.00b jhl 03/11/02 Repartitioned
driver for smaller files. 1.11a sv 03/20/07 Updated to use the new coding
guidelines. 2.00a ktn 10/20/09 Updated to use HAL processor APIs.
XUartNs550_mClearStats macro is removed. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartns550/src/xuartns550_stats.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 2.0 adk 12/10/13 Updated as per the New Tcl
API's 3.1 mus 01/14/16 Added support for microblaze Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/uartps/data/uartps_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_hello_world_example.c
This file contains a design example using the XUartPs driver in polled mode The
example uses the default setting in the XUartPs driver: . baud rate 9600 . 8 bit
data . 1 stop bit . no parity @note This example requires an external
SchmartModule connected to the pins for the device to display the 'Hello World'
message onto a hyper-terminal. MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ------ -------- 1.00a drg/jz 01/13/10 First Release 1.04a hk 22/04/13
Changed the baud rate in the example to 115200. Fix for CR707879 3.4 ms 01/23/17
Added xil_printf statement in main function to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/examples/xuartps_hello_world_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_intr_example.c This
file contains a design example using the XUartPs driver in interrupt mode. It
sends data and expects to receive the same data through the device using the
local loopback mode. @note The example contains an infinite loop such that if
interrupts are not working it may hang. MODIFICATION HISTORY: <pre> Ver Who Date
Changes ----- ------ -------- 1.00a drg/jz 01/13/10 First Release 1.00a sdm
05/25/11 Modified the example for supporting Peripheral tests in SDK 1.03a sg
07/16/12 Updated the example for CR 666306. Modified the device ID to use the
first Device Id and increased the receive timeout to 8 Removed the printf at the
start of the main Put the device normal mode at the end of the example 3.1 kvn
04/10/15 Added code to support Zynq Ultrascale+ MP. 3.1 mus 01/14/16 Added
support for intc interrupt controller 3.8 adk 10/05/19 Don't update the DeviceId
variable in peripheral test app case. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/examples/xuartps_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_low_echo_example.c This
file contains a design example using the hardware interface. First, certain
character sequence is output onto the terminal. Then any characters typed in are
echoed back, for letters, cases are switched. An 'ESC' character terminates the
execution of the example. This example requires an external SchmartModule to be
connected to the appropriate pins for the device through a daughter board. The
test uses the default settings of the device: . baud rate of 9600 . 8 bits data
. 1 stop bit . no parity @note The test hangs if communication channel from the
user terminal to the device is broken. MODIFICATION HISTORY: <pre> Ver Who Date
Changes ----- ------ -------- 1.00a drg/jz 01/13/10 First release 3.4 ms
01/23/17 Added xil_printf statement in main function to ensure that
"Successfully ran" and "Failed" strings are available in all examples. This is a
fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/examples/xuartps_low_echo_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_polled_example.c This
file contains an example using the XUartPs driver in polled mode. This function
sends data and expects to receive the data through the device using the local
loopback mode. @note If the device does not work properly, the example may hang.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 1.00a
drg/jz 01/13/10 First Release 1.03a sg 07/16/12 Modified the device ID to use
the first Device Id Removed the printf at the start of the main </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/examples/xuartps_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_selftest_example.c This
file contains an example using the XUartPs driver to do self test on the device.
@note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------
-------- 1.00a drg/jz 01/13/10 First Release 1.03a sg 08/14/12 Updated the
example for CR 666306. Modified the device ID to use the first Device Id Removed
the printf at the start of the main </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/examples/xuartps_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps.c @addtogroup
uartps_v3_8 @{ This file contains the implementation of the interface functions
for XUartPs driver. Refer to the header file xuartps.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 drg/jz 01/13/10 First Release 2.2 hk 06/23/14 SW reset of RX and
TX should be done when changing baud rate. CR 804281. 3.00 kvn 02/13/15 Modified
code for MISRA-C:2012 compliance. 3.1 kvn 04/10/15 Modified code for latest RTL
changes. 3.5 NK 09/26/17 Fix the RX Buffer Overflow issue. 3.7 aru 08/17/18
Resolved MISRA-C mandatory violations.(CR1007755) </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps.h @addtogroup
uartps_v3_8 @{ @details This driver supports the following features: - Dynamic
data format (baud rate, data bits, stop bits, parity) - Polled mode - Interrupt
driven mode - Transmit and receive FIFOs (32 byte FIFO depth) - Access to the
external modem control lines <b>Initialization & Configuration</b> The
XUartPs_Config structure is used by the driver to configure itself. Fields
inside this structure are properties of XUartPs based on its hardware build. To
support multiple runtime loading and initialization strategies employed by
various operating systems, the driver instance can be initialized in the
following way: - XUartPs_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) -
Uses a configuration structure provided by the caller. If running in a system
with address translation, the parameter EffectiveAddr should be the virtual
address. <b>Baud Rate</b> The UART has an internal baud rate generator, which
furnishes the baud rate clock for both the receiver and the transmitter. Ther
input clock frequency can be either the master clock or the master clock divided
by 8, configured through the mode register. Accompanied with the baud rate
divider register, the baud rate is determined by: <pre> baud_rate input_clock /
(bgen (bdiv + 1) </pre> where bgen is the value of the baud rate generator, and
bdiv is the value of baud rate divider. <b>Interrupts</b> The FIFOs are not
flushed when the driver is initialized, but a function is provided to allow the
user to reset the FIFOs if desired. The driver defaults to no interrupts at
initialization such that interrupts must be enabled if desired. An interrupt is
generated for one of the following conditions. - A change in the modem signals -
Data in the receive FIFO for a configuable time without receiver activity - A
parity error - A framing error - An overrun error - Transmit FIFO is full -
Transmit FIFO is empty - Receive FIFO is full - Receive FIFO is empty - Data in
the receive FIFO equal to the receive threshold The application can control
which interrupts are enabled using the XUartPs_SetInterruptMask() function. In
order to use interrupts, it is necessary for the user to connect the driver
interrupt handler, XUartPs_InterruptHandler(), to the interrupt system of the
application. A separate handler should be provided by the application to
communicate with the interrupt system, and conduct application specific
interrupt handling. An application registers its own handler through the
XUartPs_SetHandler() function. <b>Data Transfer</b> The functions,
XUartPs_Send() and XUartPs_Recv(), are provided in the driver to allow data to
be sent and received. They can be used in either polled or interrupt mode. @note
The default configuration for the UART after initialization is: - 9,600 bps or
XPAR_DFT_BAUDRATE if defined - 8 data bits - 1 stop bit - no parity - FIFO's are
enabled with a receive threshold of 8 bytes - The RX timeout is enabled with a
timeout of 1 (4 char times) <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00a drg/jz 01/12/10 First Release 1.00a sdm 09/27/11
Fixed compiler warnings and also a bug in XUartPs_SetFlowDelay where the value
was not being written to the register. 1.01a sdm 12/20/11 Removed the
InputClockHz parameter from the XUartPs instance structure and the driver is
updated to use InputClockHz parameter from the XUartPs_Config config structure.
Added a parameter to XUartPs_Config structure which specifies whether the user
has selected Modem pins to be connected to MIO or FMIO. Added the tcl file to
generate the xparameters.h 1.02a sg 05/16/12 Changed XUARTPS_RXWM_MASK to 0x3F
for CR 652540 fix. 1.03a sg 07/16/12 Updated XUARTPS_FORMAT_7_BITS and
XUARTPS_FORMAT_6_BITS with the correct values for CR 666724 Added defines for
XUARTPS_IXR_TOVR, XUARTPS_IXR_TNFUL and XUARTPS_IXR_TTRIG. Modified the name of
these defines XUARTPS_MEDEMSR_DCDX to XUARTPS_MODEMSR_DDCD XUARTPS_MEDEMSR_RIX
to XUARTPS_MODEMSR_TERI XUARTPS_MEDEMSR_DSRX to XUARTPS_MODEMSR_DDSR
XUARTPS_MEDEMSR_CTSX to XUARTPS_MODEMSR_DCTS 1.05a hk 08/22/13 Added API for
uart reset and related constant definitions. 2.0 hk 03/07/14 Version number
revised. 2.1 hk 04/16/14 Change XUARTPS_MAX_RATE to 921600. CR 780625. 2.2 hk
06/23/14 SW reset of RX and TX should be done when changing baud rate. CR
804281. 3.0 vm 12/09/14 Modified source code according to misrac guideline.
Support for Zynq Ultrascale Mp added. 3.1 kvn 04/10/15 Modified code for latest
RTL changes. Also added platform variable in driver instance structure. 3.1 adk
14/03/16 Include interrupt examples in the peripheral test when uart is
connected to a valid interrupt controller CR946803. 3.2 rk 07/20/16 Modified the
logic for transmission break bit set 3.4 ms 01/23/17 Added xil_printf statement
in main function for all examples to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix for CR-965028. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. 3.6 ms 02/16/18
Updates the flow control mode offset value in modem control register. 3.7 aru
08/17/18 Resolved MISRA-C:2012 compliance mandatory violations. </pre>

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_g.c @addtogroup
uartps_v3_8 @{ This file contains a configuration table where each entry is a
configuration structure for an XUartPs device in the system. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 drg/jz 05/13/08 First
Release 2.00 hk 22/01/14 Added check for selecting uart0 instance. 3.00 kvn
02/13/15 Modified code for MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_hw.c @addtogroup
uartps_v3_8 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 drg/jz 01/12/10 First Release 1.05a hk 08/22/13 Added reset
function 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_hw.h @addtogroup
uartps_v3_8 @{ This header file contains the hardware interface of an XUartPs
device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 drg/jz 01/12/10 First Release 1.03a sg 09/04/12 Added defines for
XUARTPS_IXR_TOVR, XUARTPS_IXR_TNFUL and XUARTPS_IXR_TTRIG. Modified the names of
these defines XUARTPS_MEDEMSR_DCDX to XUARTPS_MODEMSR_DDCD XUARTPS_MEDEMSR_RIX
to XUARTPS_MODEMSR_TERI XUARTPS_MEDEMSR_DSRX to XUARTPS_MODEMSR_DDSR
XUARTPS_MEDEMSR_CTSX to XUARTPS_MODEMSR_DCTS 1.05a hk 08/22/13 Added prototype
for uart reset and related constant definitions. 3.00 kvn 02/13/15 Modified code
for MISRA-C:2012 compliance. 3.1 kvn 04/10/15 Modified code for latest RTL
changes. 3.6 ms 02/16/18 Updates flow control mode offset value in modem control
register. </pre>

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_intr.c @addtogroup
uartps_v3_8 @{ This file contains the functions for interrupt handling <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 drg/jz
01/13/10 First Release 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. 3.1 kvn 04/10/15 Modified code for latest RTL changes. 3.7 aru
08/17/18 Resolved MISRA-C mandatory violations.(CR1007755) </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_options.c @addtogroup
uartps_v3_8 @{ The implementation of the options functions for the XUartPs
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 drg/jz 01/13/10 First Release 1.00 sdm 09/27/11 Fixed a bug in
XUartPs_SetFlowDelay where the input value was not being written to the
register. 3.00 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. 3.2 rk
07/20/16 Modified the logic for transmission break bit set </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_selftest.c @addtogroup
uartps_v3_8 @{ This file contains the self-test functions for the XUartPs
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 drg/jz 01/13/10 First Release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartps_sinit.c @addtogroup
uartps_v3_8 @{ The implementation of the XUartPs driver's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 drg/jz 01/13/10 First Release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartps/src/xuartps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ---- --- -------- 1.0 sg 09/12/17 First Release uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/uartpsv/data/uartpsv.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.0 sg 09/12/17 First Release Uses
$XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj): 0 :
MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/uartpsv/data/uartpsv_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_hello_world_example.c
This file contains a design example using the XUartPsv driver in polled mode.
The example uses the default setting in the XUartPsv driver: . baud rate 9600 .
8 bit data . 1 stop bit . no parity @note This example requires an external
SchmartModule connected to the pins for the device to display the 'Hello World'
message onto a hyper-terminal. MODIFICATION HISTORY: <pre> Ver Who Date Changes
--- --- --------- 1.0 sg 09/18/17 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/examples/xuartpsv_hello_world_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_intr_example.c This
file contains a design example using the XUartPsv driver in interrupt mode. It
sends data and expects to receive the same data through the device using the
local loopback mode. @note The example contains an infinite loop such that if
interrupts are not working it may hang. MODIFICATION HISTORY: <pre> Ver Who Date
Changes ----- ----- -------- 1.0 ms 11/30/17 First Release 1.1 sd 07/11/19
Remove the hardcoded interrupt id. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/examples/xuartpsv_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_polled_example.c This
file contains a design example using the XUartPsv driver in polled mode. It
sends data and expects to receive the same data through the device using the
local loopback mode. @note If the device does not work properly, the example may
hang. MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ----- -------- 1.0
sd 05/23/19 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/examples/xuartpsv_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_selftest_example.c
This file contains an example using the XUartPsv driver to do self test on the
device. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes --- ---
--------- 1.0 sg 09/18/17 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/examples/xuartpsv_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv.c @addtogroup
uartpsv_v1_1 @{ This file contains the implementation of the interface functions
for XUartPsv driver. Refer to the header file xuartpsv.h for more detailed
information. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- ---------
1.0 sg 09/18/17 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv.h @addtogroup
uartpsv_v1_1 @{ @details This driver supports the following features: - Dynamic
data format (baud rate, data bits, stop bits, parity) - Polled mode - Interrupt
driven mode - Transmit and receive FIFOs (32 byte FIFO depth) - Access to the
external modem control lines <b>Initialization & Configuration</b> The
XUartPsv_Config structure is used by the driver to configure itself. Fields
inside this structure are properties of XUartPsv based on its hardware build. To
support multiple runtime loading and initialization strategies employed by
various operating systems, the driver instance can be initialized in the
following way: - XUartPsv_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) -
Uses a configuration structure provided by the caller. If running in a system
with address translation, the parameter EffectiveAddr should be the virtual
address. <b>Baud Rate</b> The UART has an internal baud rate generator, which
furnishes the baud rate clock for both the receiver and the transmitter. Ther
input clock frequency can be either the master clock or the master clock divided
by 8, configured through the mode register. Accompanied with the baud rate
divider register, the baud rate is determined by: <pre> baud_rate input_clock /
(bgen (bdiv + 1) </pre> where bgen is the value of the baud rate generator, and
bdiv is the value of baud rate divider. <b>Interrupts</b> The FIFOs are not
flushed when the driver is initialized, but a function is provided to allow the
user to reset the FIFOs if desired. The driver defaults to no interrupts at
initialization such that interrupts must be enabled if desired. An interrupt is
generated for one of the following conditions. - A change in the modem signals -
Data in the receive FIFO for a configuable time without receiver activity - A
parity error - A framing error - An overrun error - Transmit FIFO is full -
Transmit FIFO is empty - Receive FIFO is full - Receive FIFO is empty - Data in
the receive FIFO equal to the receive threshold The application can control
which interrupts are enabled using the XUartPsv_SetInterruptMask() function. In
order to use interrupts, it is necessary for the user to connect the driver
interrupt handler, XUartPsv_InterruptHandler(), to the interrupt system of the
application. A separate handler should be provided by the application to
communicate with the interrupt system, and conduct application specific
interrupt handling. An application registers its own handler through the
XUartPsv_SetHandler() function. <b>Data Transfer</b> The functions,
XUartPsv_Send() and XUartPsv_Recv(), are provided in the driver to allow data to
be sent and received. They can be used in either polled or interrupt mode. @note
The default configuration for the UART after initialization is: - 9,600 bps or
XPAR_DFT_BAUDRATE if defined - 8 data bits - 1 stop bit - no parity - FIFO's are
enabled with a receive threshold of 8 bytes - The RX timeout is enabled with a
timeout of 1 (4 char times) <pre> MODIFICATION HISTORY: Ver Who Date Changes ---
--- --------- 1.0 sg 09/18/17 First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_hw.c @addtogroup
uartpsv_v1_1 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
--------- 1.0 sg 09/18/17 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_hw.h @addtogroup
uartpsv_v1_1 @{ This header file contains the hardware interface of an XUartPsv
device. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------- 1.0
sg 09/18/17 First Release </pre>

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_intr.c @addtogroup
uartpsv_v1_1 @{ This file contains the functions for interrupt handling <pre>
MODIFICATION HISTORY: Ver Who Date Changes --- --- --------- 1.0 sg 09/18/17
First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_options.c @addtogroup
uartpsv_v1_1 @{ The implementation of the options functions for the XUartPsv
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------- 1.0
sg 09/18/17 First Releasee </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv_options.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_selftest.c @addtogroup
uartpsv_v1_1 @{ This file contains the self-test functions for the XUartPsv
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------- 1.0
sg 09/18/17 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xuartpsv_sinit.c @addtogroup
uartpsv_v1_1 @{ The implementation of the XUartPsv driver's static
initialization functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes
--- --- --------- 1.0 sg 09/18/17 First Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/uartpsv/src/xuartpsv_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 5.0 adk 10/12/13 Removed support for
xps_usb2_device

FILES:
XilinxProcessorIPLib/drivers/usb/data/usb.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 5.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_M Removed the local
::hsi::utils::define_canonical_xpars API as there is a common API in the tcl of
the tools @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/usb/data/usb.tcl
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_cp9.c This file contains the USB Chapter 9 related
functions. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- 1.00a hvm 2/22/07 First release 1.01a hvm 5/30/07 Moved the USB class
specific command processing to application files. 3.00a hvm 11/18/09 Updated to
use HAL processor APIs. XUsb_mReadReg is renamed to XUsb_ReadReg and
XUsb_mWriteReg is renamed to XUsb_WriteReg. 3.02a hvm 08/16/10 Updated with the
little endian support changes. 4.00a hvm 12/20/10 Updated SetInterface function
with microphone case support. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_cp9.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_cp9.h This file contains the constants, typedefs,
variables and functions prototypes related to the USB chapter 9 related code.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- 1.00a
hvm 2/22/07 First release 1.01a hvm 5/30/07 Moved the USB class specific command
processing to application files. 4.02a bss 4/5/12 Made changes so that the flag
__LITTLE_ENDIAN__ gets defined when compiled with ARM CodeSourcery toolchain.
</pre> /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_cp9.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_dma_intr_storage.c This file has the USB example Mass
storage device application function with SCSI command processing and related
response preparation being implemented as a part of the interrupt handler. @note
The example is tested on MicroBlaze system on SP605 board, with caches included
in the H/W design. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
1.00a hvm 2/22/07 First release. 4.00a hvm 06/01/11 Signature parameter of
Command Status word is initialized with 'U''S''B''S' in ProcessRxCmd function.
CR611761 fix. 4.01a bss 11/01/11 Modified UsbIfIntrHandler function to
unconditionally reset when USB reset is asserted (CR 627574). 4.03a bss 02/05/13
Updated the example to support Zynq </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_dma_intr_storage.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_keyboard.c This file contains an example for USB keyboard.
@note - The example is tested on ML403 and ML507 evaluation boards. The push
buttons SW3,SW4,SW5 and SW7 on the ML403 evaluation board are used in the
example for the key action of the USB keyboard.The push buttons SW10, SW11,
SW12, SW13 and SW14 are used on the ML507 board. The example sends a character
from a fixed sequence of characters from the device as and when any of the SW3
or SW4 or SW5 and SW7 push button is pressed. The fixed sequence of characters
is XILINX USB KEYBOARD DEMO. The SW6 push button switch is used to complete the
test. SW14 is used on ML507 board to complete the test. - The GPIO device has to
be added to the hardware design so that the push buttons on the evaluation board
could be used. If we enable the debug statements in the xusb_cp9.c file, we must
add the UARTLite core to the hardware design. Debug messages can be enabled by
defining the constant XUSB_DEBUG, - To run this example, the evaluation board is
to be connected to a windows Host PC over the USB port. - The example configures
the USB device for endpoint 0 and endpoint 1. Endpoint 0 is the control endpoint
and is configured for a maximum packet length of 64 bytes. End point 1 is
configured for INTERRUPT IN transactions and the maximum packet size is
configured as 16 bytes. - The USB keyboard example code has to be compiled along
with the xusb_cp9.c file. The xusb_cp9.c file contains all the USB enumeration
related functions. To compile the code for USB keyboard example, the constant
definitions HID_DEVICES and USB_KEYBOARD are to be defined and the definitions
the constants USB_MOUSE and MASS_STORAGE_DEVICE are to be undefined. These
definitions can be found in the xusb_types.h file. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- 1.00a hvm 5/31/07 First release 3.00a hvm
11/18/09 Updated to use HAL processor APIs. XUsb_mReadReg is renamed to
XUsb_ReadReg and XUsb_mWriteReg is renamed to XUsb_WriteReg. 4.00a hvm 08/11/11
Updated the code in gpio isr to increment the index by 4 as a dummy byte is
added in the Message variable in keyboard.h file to handle the address alignment
issue. 4.02a bss 11/01/11 Modified UsbIfIntrHandler function to unconditionally
reset when USB reset is asserted (CR 627574). </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_keyboard.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_keyboard.h This file contains the constants, type
definitions, variables and function prototypes used in the USB keyboard example.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- 1.00a
hvm 5/31/07 First release 3.02a hvm 08/16/10 Updated with the little endian
support changes. 4.00a hvm 08/11/11 Updated the Message[] variable data to
handle the address alignment issue. 4.02a bss 11/01/11 Number of endpoints
changed from 0x00 to 0x01 in FsUsbConfig to support Full Speed (CR 627573).
</pre> /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_keyboard.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusb_microphone.c This file
contains usb Microphone application related functions. This example only
provides a reference as to how an isochronous transfer related application can
be written. This example emulates a microphone and when connected to a Windows
PC will be detected as a Microphone and if we open sound recorder and start
recording data, this example sends data on isochronous endpoint and the PC can
store this data. Noise will be heard when this data is played on the PC. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- 1.00a hvm
12/20/10 First release 4.01a bss 11/01/11 Modified UsbIfIntrHandler function to
unconditionally reset when USB reset is asserted (CR 627574). 4.02a bss 02/20/12
Modified main function to call Xil_DCacheFlushRange when DMA is enabled.(CR
640005) </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_microphone.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusb_microphone.h This file
contains the constants, type definitions, variables and function prototypes used
in the usb microphone application. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- 1.00a hvm 12/20/10 First release 4.02a bss 02/20/12
Modified to include Little Endian and Big Endian descriptors. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_microphone.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_mouse.c This file contains an example for USB Mouse. @note
- The example is tested on ML403 and ML507 evaluation boards. The push buttons
SW3,SW4,SW5 and SW7 on the ML403 evaluation board are used in the example for
the mouse movement of the USB mouse. The push buttons used on ML507 board are
SW10,SW11 SW12,SW13 and SW14. The cursor on the host PC moves as and when any of
the SW3 or SW4 or SW5 and SW7 push button is pressed. The SW6 push button switch
is used to complete the test. The push buttons on the ML507 board for cursor
movement are SW10, SW11, SW 12 and SW13. The push button for completing the test
is SW14. - The GPIO device has to be added to the hardware design so that the
push buttons on the evaluation board could be used. If we enable the debug
statements in the xusb_cp9.c file, we must add the UARTLite core to the hardware
design. Debug messages can be enabled by defining the constant XUSB_DEBUG, - To
run this example, the evaluation board is to be connected to a windows Host PC
over the USB port. - The example configures the USB device for endpoint 0 and
endpoint 1. Endpoint 0 is the control endpoint and is configured for a maximum
packet length of 64 bytes. End point 1 is configured for INTERRUPT IN
transactions and the maximum packet size is configured as 16 bytes. - The USB
mouse example code has to be compiled along with the xusb_cp9.c file. The
xusb_cp9.c file contains all the USB enumeration related functions. To compile
the code for USB mouse example, the constant definitions HID_DEVICES and
USB_MOUSE are to be defined and the definitions the constants USB_KEYBOARD and
MASS_STORAGE_DEVICE are to be undefined. These definitions can be found in the
xusb_types.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
1.00a hvm 6/21/07 First release 3.00a hvm 11/18/09 Updated to use HAL processor
APIs. XUsb_mReadReg is renamed to XUsb_ReadReg and XUsb_mWriteReg is renamed to
XUsb_WriteReg. 4.02a bss 11/01/11 Modified UsbIfIntrHandler function to
unconditionally reset when USB reset is asserted (CR 627574). </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_mouse.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_mouse.h This file contains the constants, type
definitions, variables and function prototypes used in the mouse application.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- 1.00a
hvm 3/30/07 First release 3.02a hvm 08/16/10 Updated with the little endian
support changes. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_mouse.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusb_phy_read_write.c This file
contains PHY register access related example. @note This example only shows
reading and writing to the ULPI PHY SCRATCH register.The user can access any
other register as per their requirement. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- 1.00a hvm 12/3/10 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_phy_read_write.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_storage.c This file contains Mass storage device
application related functions. @note The example is tested on MicroBlaze, PPC405
and 440 systems with caches included in the H/W design and also with systems not
having caches. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- 1.00a
hvm 2/22/07 First release 1.01a hvm 5/30/07 Added code to handle endpoint zero
class specific commands. Added support for PPC. 1.01a hvm 10/2/08 The complete
SCSI READ command processing implementation is modified. The send processing is
shifted into the endpoint one interrupt handler.Updated the code to enable
caches. 2.00a hvm 12/08/08 Updated the example with cache APIs 2.00a hvm
03/12/09 Updated the example with DMA Done check for every transaction
initiated. 3.00a hvm 11/18/09 Updated to use HAL processor APIs. XUsb_mReadReg
is renamed to XUsb_ReadReg and XUsb_mWriteReg is renamed to XUsb_WriteReg. 3.02a
hvm 08/16/10 Updated with the little endian support changes. 4.00a hvm 06/01/11
Signature parameter of Command Status word is initialized with 'U''S''B''S' in
ProcessRxCmd function. CR611761 fix. 4.00a hvm 24/06/11 The cache flush call
with 512 size in EP1 handler is moved inside the HIGHSPEED condition. CR614791
4.02a bss 11/01/11 Modified UsbIfIntrHandler function to unconditionally reset
when USB reset is asserted (CR 627574). 5.2 MNK 03/30/2016 Modified the example
to support ZYNQMP. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_storage.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_storage.h This file contains the constants, type
definitions, variables and function prototypes used in the mass storage
application. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- 1.00a hvm 2/12/07 First release 1.01a hvm 10/2/08 The variables IntLba in
Lba and IntBlockCount in BlockCount are declared as volatile. 2.00a hvm 03/12/09
Modified the RAMDISKSECTORS constant value from 0x4000 to 0x400 as this would
reduce the code size and the example can run in a smaller memory systems. 3.02a
hvm 08/16/10 Updated with the little endian support changes. 4.00a hvm 10/25/10
Updated with DmaIntrHandler function prototype. Updated INQUIRY command with pad
values. 4.00a hvm 06/01/11 Modified the USB Mass Storage Command Status Wrapper
structure. The union for Signature is removed and only the array definition of
Signature is retained. CR611761 fix. 4.00a hvm 06/24/11 Updated the INQUIRY
command fourth parameter value to 0. CR614794 4.01a hvm 08/11/11 Updated the
RamDisk variable to have a 32 bit address alignment. 4.01a hvm 09/14/11 Fixed
the compilation issue at the RamDisk variable declaration. CR625055. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_storage.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_storage_polled_mode.c This file contains Mass storage
device application related functions implemented in polled mode. @note The
example is tested on MicroBlaze, with caches included in the H/W design. This
example works for USB high speed interface only. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- 4.00a hvm 05/24/11 Created based on the
xusb_storage.c example. 4.01a bss 11/01/11 Modified UsbIfIntrHandler function to
unconditionally reset when USB reset is asserted (CR 627574). 4.02a bss 04/05/12
Modified the sequence of Cache Flush and Invalidation. The cache flush happens
just before the driver API EPDataSend is called. Similarly the cache
invalidation is done after the call to EPDataReceive and after the dma transfer
is over. </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_storage_polled_mode.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_types.h This file contains the constants, type
definitions, variables as used in the USB chapter 9 and mass storage demo
application. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- 1.00a hvm 2/22/07 First release 4.00a hvm 12/20/10 Updated with the Audio
device definitions. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usb/examples/xusb_types.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb.c @addtogroup usb_v5_2 @{ The XUsb driver. Functions in
this file are the minimum required functions for this driver. See xusb.h for a
detailed description of the driver. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- 1.00a hvm 2/22/07 First release 2.00a hvm 10/22/08
Added DMA APIs. 3.00a hvm 12/3/09 Added XUsb_ReadErrorCounters API to return USB
error counters data. Updated to use HAL processor APIs. XUsb_mReadReg is renamed
to XUsb_ReadReg and XUsb_mWriteReg is renamed to XUsb_WriteReg. 3.02a hvm
7/15/10 Added Device ID initialization in XUsb_CfgInitialize function
(CR555996). 4.00a hvm 10/21/10 Added ULPI PHY Read/Write APIs. Added DMA handler
initialization in XUsb_CfgInitialize function 4.03a bss 06/20/10 Added SIE Reset
API (XUsb_SieReset) to reset the SIE state machine (CR 660602) 5.1 sk 11/10/15
Used UINTPTR instead of u32 for Baseaddress CR 867425. Changed the prototype of
XUsb_CfgInitialize API. 5.2 MNK 29/03/15 Added 64bit changes for ZYNQMP. </pre>
/ Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/src/xusb.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb.h @addtogroup usb_v5_2 @{ @details This file contains the
implementation of the XUsb component. It is the driver for the USB device
controller. The USB device controller supports the following features: - USB 2.0
Specification supporting High/Full/Low Speed - 8 Endpoints - 1 Control Endpoint
- 7 Configurable Endpoints, which can be configured as IN or OUT , and
configurable as Interrupt or Bulk or Isochronous - 2 Ping Pong Buffers for all
the endpoints except the Control Endpoint <b>Initialization & Configuration</b>
The device driver enables higher layer software (e.g., an application) to
communicate to the USB device. Apart from transmission and reception of USB
frames the driver also handles the configuration of the device. A single device
driver can support multiple USB devices. XUsb_CfgInitialize() API is used to
initialize the USB device. The user needs to first call the XUsb_LookupConfig()
API which returns the Configuration structure pointer which is passed as a
parameter to the XUsb_CfgInitialize() API. - Configuration of the DEVICE
endpoints: The endpoints of the device need to be configured using the
XUsb_EpConfigure() function call. After configuration is complete, the endpoints
need to be initialized using the XUsb_EpInitializeAll() function call. <b> PHY
Communication </b> As the H/W doesn't give any provision for the driver to
configure the PHY, the driver doesn't provide any mechanism for directly
programming the PHY. <b> DMA </b> The USB device has an inbuilt DMA. It's a
simple DMA for data transfer between endpoint buffer memory and the external
memory. The driver has two APIs for DMA operation. one API is used for resetting
the DMA module of the USB device. The other API is for initiating the DMA
transfer. The DMA transfer API is internal to the driver and is used by the USB
endpoint data send and data receive functions. Upon completion of DMA transfer
the USB device sets the buffer ready bit of the endpoint for which the DMA
transfer is initiated. Setting of the buffer ready bit enables
transmission/reception of an endpoint data. To enable the USB device to know to
which endpoint the current DMA transfer is initiated, the driver writes the
buffer ready mask to the DMA control register. The DMA in the device can be
enabled or disabled only during the system build time. <b> Interrupts </b> The
driver provides an interrupt handler XUsb_IntrHandler for handling the interrupt
from the USB device. The users of this driver have to register this handler with
the interrupt system and provide the callback functions. The interrupt handlers
and associated callback functions for the USB device have to be registered by
the user using the XUsb_IntrSetHandler() function and/or XUsb_EpSetHandler()
function. XUsb_IntrSetHandler() function installs an asynchronous callback
function for the general interrupts (interrupts other than the endpoint
interrupts). XUsb_EpSetHandler() function installs the callback functions for
the interrupts related to the endpoint events. A separate callback function has
to be installed for each of the endpoints. <b> Virtual Memory </b> This driver
supports Virtual Memory. The RTOS is responsible for calculating the correct
device base address in Virtual Memory space. <b> Threads </b> This driver is not
thread safe. Any needs for threads or thread mutual exclusion must be satisfied
by the layer above this driver. <b> Asserts </b> Asserts are used within all
Xilinx drivers to enforce constraints on argument values. Asserts can be turned
off on a system-wide basis by defining, at compile time, the NDEBUG identifier.
By default, asserts are turned on and it is recommended that users leave asserts
on during development. <b> Building the driver </b> The XUsb driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a hvm 02/22/07 First release. 1.01a hvm 05/30/07
The chapter 9 files are moved to examples directory. 1.01a sdm 08/22/08 Removed
support for static interrupt handlers from the MDD file 1.01a hvm 10/02/08 The
Buffer0Ready, Buffer1Ready are declared as volatile. In function
XUsb_EpDataRecv, the initialization of Buffer0Ready, Buffer1Ready and CurBufNum
variables is moved before the buffer ready bit is set in the buffer ready
register. Added the initialization of Buffer0Ready, Buffer1Ready and CurBufNum
variables in the XUsb_EpDataSecd function. 2.00a hvm 10/22/08 Added Support for
the new XPS USB device. The new device has support for DMA. Apart from the DMA,
remote wakeup feature is also added the USB device. However, there is no
additional code needed to be added in the driver to support this feature. 3.00a
hvm 12/03/09 Added the modifications related to the new USB error reporting
register in the XPS USB device. Updated to use HAL processor APIs. Removed _m
from the name of the macros. XUsb_mReadReg is renamed to XUsb_ReadReg and
XUsb_mWriteReg is renamed to XUsb_WriteReg. 3.01a hvm 5/20/10 Updated with fix
for CR561171.The interrupt handler is updated to call the error handler callback
function during error interrupts. 3.02a hvm 7/15/10 Added Device ID
initialization in XUsb_CfgInitialize function (CR555996). 3.02a hvm 8/5/10
Updated the XUsb_EpDataRecv function to ensure that the buffer ready bit setup
is now made only during non-DMA case. CR570776. 3.02a hvm 8/16/10 Updated the
examples with the little endian support. 4.00a hvm 10/21/10 Added new API
XUsb_DmaIntrSetHandler for setting up DMA handler. Updated the XUsb_IntrHandler
function to call the DMA handler to handle DMA events. Removed DmaDone and
DmaError variables from the XUsb structure. Added two new APIs to provide access
to the new ULPI PHY register. 4.01a hvm 8/23/11 Added new bit definitions for
isochronous transfer bits in endpoint configuration register. Added a new API
for setting these bits for a given endpoint. These bits are available only in
the newer versions of the AXI USB IP. Check the IP datasheet for more details.
4.02a bss 3/04/12 Modified XCOMPONENT_IS_READY to XIL_COMPONENT_IS_READY CR
650877 4.03a bss 06/20/10 Added SIE Reset API to reset (XUsb_SieReset) the SIE
state machine in xusb.c and SIE Reset Mask in xusb_l.h for CR 660602 4.04a bss
10/22/13 Added macros for HSIC PHY registers in xusb_l.h. 5.0 adk 19/12/13
Updated as per the New Tcl API's 5.1 sk 11/10/15 Used UINTPTR instead of u32 for
Baseaddress CR 867425. Changed the prototype of XUsb_CfgInitialize API. 5.2 MNK
29/03/15 Added 64bit changes for ZYNQMP. ms 03/17/17 Modified text file in
examples folder for doxygen generation. 5.3 asa 02/05/19 Added
dependencies.props in data folder for importing examples in SDK. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usb/src/xusb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_endpoint.c @addtogroup usb_v5_2 @{ This file contains the
USB end point related function definitions. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- 1.00a hvm 2/22/07 First release 1.01a
hvm 10/2/08 In function XUsb_EpDataRecv, the initialization of Buffer0Ready,
Buffer1Ready and CurBufNum variables is moved before the buffer ready bit is set
in the buffer ready register. Added the initialization of Buffer0Ready,
Buffer1Ready and CurBufNum variables in the XUsb_EpDataSend function. 2.00a hvm
12/2/08 Updated the XUsb_EpDataSend and XUsb_EpRecv functions to provide support
for DMA and non DMA modes of data transfer. 3.00a hvm 11/18/09 Updated to use
HAL processor APIs. Removed _m from the name of the macros. 3.02a hvm 8/5/10
Updated the XUsb_EpDataRecv function to ensure that the buffer ready bit setup
is now made only during non-DMA case. CR570776. 4.01a hvm 8/23/11 Added an API
to set the number of isochronous transfers in a microframe for a given endpoint.
</pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/src/xusb_endpoint.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_g.c @addtogroup usb_v5_2 @{ This file contains a
configuration table that specifies the configuration of the USB devices in the
system. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a hvm 2/22/07 First release 2.00a hvm 12/2/08 Updated the
configuration structure with the INCLUDE_DMA option. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/src/xusb_g.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_intr.c @addtogroup usb_v5_2 @{ This file contains the
functions that are related to interrupt processing for the USB device. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- 1.00a hvm 2/22/07 First
release. 2.00a hvm 12/2/08 Updated the interrupt handler for handling the new
DMA bits defined in the interrupt status register. 3.00a hvm 12/3/09 Updated to
use HAL processor APIs. Removed _m from the Added the interrupt handling for the
error interrupts. Added new API XUsb_ErrIntrSetHandler for setting up error
handler. 3.01a hvm 5/20/10 Updated with fix for CR561171. The interrupt handler
is updated to call the error handler callback function during error interrupts.
4.00a hvm 9/01/10 Added new API XUsb_DmaIntrSetHandler for setting up DMA
handler. Updated the XUsb_IntrHandler function to call the DMA handler to handle
DMA events. Removed the DmaDone and DmaError variable usage from the
XUsb_IntrHandler function. Added interrupt handling for ULPI PHY interrupts.
4.02a bss 3/04/12 Modified XCOMPONENT_IS_READY to XIL_COMPONENT_IS_READY CR
650877 </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/src/xusb_intr.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_l.h @addtogroup usb_v5_2 @{ This header file contains
identifiers and low-level driver function prototypes (or macros) that can be
used to access the USB device. High-level driver function prototypes are defined
in xusb.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a hvm 2/22/07 First release 2.00a hvm 12/2/08 Updated the register offset
values as per the new USB device datasheet. Added new bitmasks related to DMA
operation as defined in the datasheet. 3.00a hvm 10/28/09 Updated the new USB
error register related constants 3.00a hvm 11/18/09 Updated to use HAL processor
APIs. XUsb_mReadReg is renamed to XUsb_ReadReg and XUsb_mWriteReg is renamed to
XUsb_WriteReg. Updated the new USB error register related constants. 4.00a hvm
10/21/10 Updated the ULPI PHY and interrupt register related constants. 4.01a
hvm 08/23/11 Updated with High bandwidth Isochronous bit definitions 4.03a bss
06/20/10 Added SIE Reset Mask (CR 660602) 4.04a bss 10/22/13 Added macros for
HSIC PHY registers. </pre>

FILES:
XilinxProcessorIPLib/drivers/usb/src/xusb_l.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Copyright (C) 2006 Vreelin Engineering, Inc. All Rights Reserved. All rights
reserved. This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xusb_sinit.c @addtogroup usb_v5_2 @{ This file contains the
implementation of the XUsb driver's static initialization functionality. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
hvm 12/28/06 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usb/src/xusb_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_ch9.c This file contains
the implementation of the chapter 9 code for the example. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 10/10/10 First
release 1.04a nm 02/05/13 Fixed CR 696550. Added template code for Vendor
request. 1.04a nm 03/04/13 Fixed CR 704022. Implemented TEST_MODE Feature. 1.06a
kpc 11/11/13 Always use global memory for dma operations 2.1 kpc 4/29/14 Align
dma buffers to cache line boundary 2.4 vak 4/01/19 Fixed IAR data_alignment
warnings </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/examples/xusbps_ch9.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_ch9.h This file contains
definitions used in the chapter 9 code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a wgr 10/10/10 First release 1.04a nm 03/04/13
Fixed CR 704022. Implemented TEST_MODE Feature. 2.1 kpc 04/28/14 Added macros
specific to cache operations </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbps/examples/xusbps_ch9.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_ch9_storage.c This file
contains the implementation of the storage specific chapter 9 code for the
example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a wgr 10/10/10 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/examples/xusbps_ch9_storage.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_ch9_storage.h This file
contains definitions used in the chapter 9 code. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a wgr 10/10/10 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbps/examples/xusbps_ch9_storage.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_class_storage.c This
file contains the implementation of the storage class code for the example.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wgr
10/10/10 First release 2.1 kpc 4/28/14 Align DMA buffers to cache line boundary
2.4 vak 4/01/19 Fixed IAR data_alignment warnings </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/examples/xusbps_class_storage.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_class_storage.h This
file contains definitions used in the chapter 9 code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wgr 10/10/10 First
release ms 04/10/17 Modified filename tag to include the file in doxygen
examples. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbps/examples/xusbps_class_storage.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_intr_example.c This file
contains an example of how to use the USB driver with the USB controller in
DEVICE mode. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a wgr/nm 10/09/10 First release 1.01a nm 03/05/10 Included
xpseudo_asm.h instead of xpseudo_asm_gcc.h 1.04a nm 02/05/13 Fixed CR 696550.
Added template code for Vendor request. 1.06a kpc 11/11/13 Fixed CR759458,
cacheInvalidate size should be ailgned to cache line size. 2.1 kpc 04/28/14
Cleanup and removed unused functions 2.4 vak 04/01/19 Fixed IAR data_alignment
warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/examples/xusbps_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps.c @addtogroup usbps_v2_4
@{ The XUsbPs driver. Functions in this file are the minimum required functions
for this driver. See xusbps.h for a detailed description of the driver. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
jz 10/10/10 First release 2.1 kpc 04/28/14 Removed unused functions </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps.h @addtogroup usbps_v2_4
@{ @details This file contains the implementation of the XUsbPs driver. It is
the driver for an USB controller in DEVICE or HOST mode. <h2>Introduction</h2>
The Spartan-3AF Embedded Peripheral Block contains a USB controller for
communication with serial peripherals or hosts. The USB controller supports
Host, Device and On the Go (OTG) applications. <h2>USB Controller Features</h2>
- Supports Low Speed USB 1.1 (1.5Mbps), Full Speed USB 1.1 (12Mbps), and High
Speed USB 2.0 (480Mbps) data speeds - Supports Device, Host and OTG operational
modes - ULPI transceiver interface for USB 2.0 operation - Integrated USB Full
and Low speed serial transceiver interfaces for lowest cost connections
<h2>Initialization & Configuration</h2> The configuration of the USB driver
happens in multiple stages: - (a) Configuration of the basic parameters: In this
stage the basic parameters for the driver are configured, including the base
address and the controller ID. - (b) Configuration of the DEVICE endpoints (if
applicable): If DEVICE mode is desired, the endpoints of the controller need to
be configured using the XUsbPs_DeviceConfig data structure. Once the endpoint
configuration is set up in the data structure, The user then needs to allocate
the required amount of DMAable memory and finalize the configuration of the
XUsbPs_DeviceConfig data structure, e.g. setting the DMAMemVirt and DMAMemPhys
members. - (c) Configuration of the DEVICE modes: In the second stage the
parameters for DEVICE are configured. The caller only needs to configure the
modes that are actually used. Configuration is done with the:
XUsbPs_ConfigureDevice() Configuration parameters are defined and passed into
these functions using the: XUsbPs_DeviceConfig data structures. <h2>USB Device
Endpoints</h2> The USB core supports up to 4 endpoints. Each endpoint has two
directions, an OUT (RX) and an IN (TX) direction. Note that the direction is
viewed from the host's perspective. Endpoint 0 defaults to be the control
endpoint and does not need to be set up. Other endpoints need to be configured
and set up depending on the application. Only endpoints that are actuelly used
by the application need to be initialized. See the example code
(xusbps_intr_example.c) for more information. <h2>Interrupt Handling</h2> The
USB core uses one interrupt line to report interrupts to the CPU. Interrupts are
handled by the driver's interrupt handler function XUsbPs_IntrHandler(). It has
to be registered with the OS's interrupt subsystem. The driver's interrupt
handler divides incoming interrupts into two categories: - General device
interrupts - Endopint related interrupts The user (typically the adapter layer)
can register general interrupt handler functions and endpoint specific interrupt
handler functions with the driver to receive those interrupts by calling the
XUsbPs_IntrSetHandler() and XUsbPs_EpSetHandler() functions respectively.
Calling these functions with a NULL pointer as the argument for the function
pointer will "clear" the handler function. The user can register one handler
function for the generic interrupts and two handler functions for each endpoint,
one for the RX (OUT) and one for the TX (IN) direction. For some applications it
may be useful to register a single endpoint handler function for muliple
endpoints/directions. When a callback function is called by the driver,
parameters identifying the type of the interrupt will be passed into the handler
functions. For general interrupts the interrupt mask will be passed into the
handler function. For endpoint interrupts the parameters include the number of
the endpoint, the direction (OUT/IN) and the type of the interrupt. <h2>Data
buffer handling</h2> Data buffers are sent to and received from endpoint using
the XUsbPs_EpBufferSend(), XUsbPs_EpBufferSendWithZLT() and
XUsbPs_EpBufferReceive() functions. User data buffer size is limited to 16
Kbytes. If the user wants to send a data buffer that is bigger than this limit
it needs to break down the data buffer into multiple fragments and send the
fragments individually. From the controller perspective Data buffers can be
aligned at any boundary. if the buffers are from cache region then the buffer
and buffer size should be aligned to cache line aligned <h3>Zero copy</h3> The
driver uses a zero copy mechanism which imposes certain restrictions to the way
the user can handle the data buffers. One restriction is that the user needs to
release a buffer after it is done processing the data in the buffer. Similarly,
when the user sends a data buffer it MUST not re-use the buffer until it is
notified by the driver that the buffer has been transmitted. The driver will
notify the user via the registered endpoint interrupt handling function by
sending a XUSBPS_EP_EVENT_DATA_TX event. <h2>DMA</h2> The driver uses DMA
internally to move data from/to memory. This behaviour is transparent to the
user. Keeping the DMA handling hidden from the user has the advantage that the
same API can be used with USB cores that do not support DMA. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wgr 10/10/10 First
release 1.02a wgr 05/16/12 Removed comments as they are showing up in SDK Tabs
for CR 657898 1.03a nm 09/21/12 Fixed CR678977. Added proper sequence for setup
packet handling. 1.04a nm 10/23/12 Fixed CR 679106. 11/02/12 Fixed CR 683931.
Mult bits are set properly in dQH. 2.00a kpc 04/03/14 Fixed CR777763. Corrected
the setup tripwire macro val. 2.1 kpc 04/28/14 Removed unused function
prototypes 2.2 kpc 08/23/14 Exported XUsbPs_DeviceReset API as global for
calling in code coverage tests. 2.3 kpc 02/19/14 Fixed CR873972, CR873974.
Corrected the logic for proper moving of dTD Head/Tail Pointers. Invalidate the
cache after buffer receive in Endpoint Buffer Handler. 2.4 sg 04/26/16 Fixed
CR949693, Corrected the logic for EP flush ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/10/17 Modified filename tag to
include the file in doxygen examples. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_endpoint.c @addtogroup
usbps_v2_4 @{ Endpoint specific function implementations. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 10/10/10
First release 1.03a nm 09/21/12 Fixed CR678977. Added proper sequence for setup
packet handling. 1.04a nm 11/02/12 Fixed CR683931. Mult bits are set properly in
dQH. 2.00a kpc 04/03/14 Fixed CR777763. Updated the macro names 2.1 kpc 04/28/14
Added XUsbPs_EpBufferSendWithZLT api and merged common code to
XUsbPs_EpQueueRequest. 2.3 bss 01/19/16 Modified XUsbPs_EpQueueRequest function
to fix CR873972 (moving of dTD Head/Tail Pointers)and CR873974(invalidate Caches
After Buffer Receive in Endpoint Buffer Handler...) </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps_endpoint.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_endpoint.h @addtogroup
usbps_v2_4 @{ This is an internal file containung the definitions for endpoints.
It is included by the xusbps_endpoint.c which is implementing the endpoint
functions and by xusbps_intr.c. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a wgr 10/10/10 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps_endpoint.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_g.c @addtogroup
usbps_v2_4 @{ This file contains a configuration table where each entry is a
configuration structure for an XUsbPs device in the system. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a wgr 10/10/10 First
release 2.00 hk 22/01/14 Added check to select second instance. </pre> / Include
Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_hw.c @addtogroup
usbps_v2_4 @{ The implementation of the XUsbPs interface reset functionality
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.05a kpc
10/10/10 first version </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_hw.h @addtogroup
usbps_v2_4 @{ This header file contains identifiers and low-level driver
functions (or macros) that can be used to access the device. High-level driver
functions are defined in xusbps.h. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a wgr 10/10/10 First release 1.04a nm 10/23/12
Fixed CR 679106. 1.05a kpc 07/03/13 Added XUsbPs_ResetHw function prototype
2.00a kpc 04/03/14 Fixed CR777764. Corrected max endpoint vale and masks </pre>
/

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_intr.c @addtogroup
usbps_v2_4 @{ This file contains the functions that are related to interrupt
processing for the EPB USB driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a jz 10/10/10 First release 1.03a nm 09/21/12
Fixed CR678977. Added proper sequence for setup packet handling. 2.3 bss
01/19/16 Modified XUsbPs_EpQueueRequest function to fix CR873972 (moving of dTD
Head/Tail Pointers properly). </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_sinit.c @addtogroup
usbps_v2_4 @{ The implementation of the XUsbPs driver's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a wgr 10/10/10 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbps/src/xusbps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 sg 06/06/16 First release 1.3 vak 16/08/17
Export CCI related information 1.4 vak 24/09/18 Added SUPER_SPEED parameter 1.5
vak 13/02/19 Correct the logic for setting SUPER_SPEED parameter uses
"xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/usbpsu/data/usbpsu.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_audio_dfu_example.c This
file implements AUDIO-DFU composite class example. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 rb 22/01/18 First release </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_audio_dfu_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9.c This file contains
the implementation of chapter 9 specific code for the example. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sg 06/06/16
First release 1.1 vak 30/11/16 Added DFU support 1.4 BK 12/01/18 Renamed the
file and added changes to have a common example for all USB IPs. 1.5 vak
13/02/19 Added support for versal 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9.h This file contains
definitions used chapter 9 specific code. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 sg 06/06/16 First release 1.1 vak 30/11/16
updated for adding ch9 function callbacks 1.2 mn 01/20/17 fix to assign EP
number and direction from wIndex field 1.4 BK 12/01/18 Renamed the file and
added changes to have a common example for all USB IPs. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_audio_dfu.c This
file contains the implementation of the AUDO-DFU composite device specific
chapter 9 code for the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 rb 22/02/18 First release 1.5 vak 03/25/19 Fixed
incorrect data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_audio_dfu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_audio_dfu.h This
file contains definitions used in AUDIO-DFU composite device specific chapter 9
code. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
rb 22/02/18 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_audio_dfu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_composite.c This
file contains the implementation of the composite device specific chapter 9 code
for the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 rb 05/03/18 First release 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_composite.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_composite.h This
file contains definitions used in composite device specific chapter 9 code.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb
05/03/18 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_composite.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_dfu.c This file
contains the implementation of the DFU specific chapter 9 code for the example.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 vak
30/11/16 Added DFU support 1.4 BK 12/01/18 Renamed the file to be in sync with
usb common code changes for all USB IPs 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_dfu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_dfu.h This file
contains definitions used in DFU specific chapter 9 code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 vak 30/11/16 Added DFU
support 1.4 BK 12/01/18 Renamed the file to be in sync with usb common code
changes for all USB IPs </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_dfu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_storage.c This file
contains the implementation of the Mass Storage specific chapter 9 code for the
example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 sg 06/06/16 First release 1.4 BK 12/01/18 Renamed the file and added changes
to have a common example for all USB IPs. 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_storage.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_ch9_storage.h This file
contains definitions used in the Mass Storage specific chapter 9 code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sg 06/06/16
First release 1.4 BK 12/01/18 Renamed the file and added changes to have a
common example for all USB IPs. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_ch9_storage.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_audio_dfu.c This
file contains the implementation of the AUDIO-DFU composite device specific
class code for the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 rb 22/02/18 First release 1.5 vak 13/02/19 Added support
for versal 1.5 vak 03/25/19 Fixed incorrect data_alignment pragma directive for
IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_audio_dfu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_audio_dfu.h This
file contains definitions used in the AUDIO-DFU composite class code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 22/02/18
First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_audio_dfu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_composite.c This
file contains the implementation of the composite device specific class code for
the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 rb 05/03/18 First release 1.5 vak 13/02/19 Added support for versal
1.5 vak 03/25/19 Fixed incorrect data_alignment pragma directive for IAR </pre>
/ Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_composite.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_composite.h This
file contains definitions used in the composite device class code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 05/03/18
First release 1.5 vak 13/02/19 Added support for versal 1.5 vak 03/25/19 Fixed
incorrect data_alignment pragma directive for IAR </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_composite.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_dfu.c This file
contains the implementation of the DFU specific class code for the example.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 vak
30/11/16 Added DFU support 1.4 BK 12/01/18 Renamed the file to be in sync with
usb common code changes for all USB IPs 1.5 vak 13/02/19 Added support for
versal </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_dfu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_dfu.h This file
contains definitions used in the DFU class code. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 vak 30/11/16 Added DFU support 1.4 BK
12/01/18 Renamed the file to be in sync with usb common code changes for all USB
IPs </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_dfu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_storage.c This
file contains the implementation of the Mass Storage specific class code for the
example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 sg 06/06/16 First release ms 04/10/17 Modified filename tag to include the
file in doxygen examples. 1.4 BK 12/01/18 Renamed the file and added changes to
have a common example for all USB IPs. 1.5 vak 13/02/19 Added support for versal
1.5 vak 03/25/19 Fixed incorrect data_alignment pragma directive for IAR </pre>
/ Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_storage.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_class_storage.h This
file contains definitions used in the Mass Storage class code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 sg 06/06/16
First release 1.4 BK 12/01/18 Renamed the file and added changes to have a
common example for all USB IPs. </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_class_storage.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_composite_example.c This
file implements mass storage, hid, audio and dfu all in one composite device.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb
05/03/18 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_composite_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_intr_example.c This file
implements DFU class example. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 vak 30/11/16 First release 1.4 BK 12/01/18 Renamed the
file to be in sync with usb common code changes for all USB IPs vak 22/01/18
Added changes for supporting microblaze platform vak 13/03/18 Moved the setup
interrupt system calls from driver to example. 1.5 vak 13/02/19 Added support
for versal </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_dfu_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_audio.c This
file implements the ISO IN and ISO OUT data transfer. It transfers and receives
audio data on High or Super Speed bus based on connection. @setup requirement
zcu102 board in usb device mode, connected with host using USB 3.0 cable
Following other files require to run this example o xusb_ch9.c, xusb_ch9.h o
xusb_freertos_ch9_audio.c, xusb_freerots_ch9_audio.h o
xusb_freertos_class_audio.c, xusb_freertos_class_audio.h @validation o on
success example will be detected as audio device o use aplay/arecord for play or
record audio <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 rb 26/03/18 First release 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_audio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusb_freertos_ch9_audio.c This
file contains the implementation of the audio specific chapter 9 code for the
example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 rb 26/03/18 First release 1.5 vak 03/25/19 Fixed incorrect data_alignment
pragma directive for IAR </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_audio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_ch9_audio.h
This file contains definitions used in the chapter 9 code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 26/03/18 First release
</pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_audio.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_ch9_composite.c
This file contains the implementation of the composite device specific chapter 9
code for the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 rb 28/03/18 First release 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_composite.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_ch9_composite.h
This file contains definitions used in composite device specific chapter 9 code.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb
28/03/18 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_composite.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_ch9_keyboard.c
This file contains the implementation of the keyboard specific chapter 9 code
for the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 rb 22/03/18 First release 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_keyboard.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_ch9_keyboard.h
This file contains definitions used in the keyboard specific chapter 9 code.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb
22/03/18 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_keyboard.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_ch9_storage.c
This file contains the implementation of the Mass Storage specific chapter 9
code for the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 rb 22/03/18 First release 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_storage.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_ch9_storage.h
This file contains definitions used in the Mass Storage specific chapter 9 code.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb
22/03/18 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_ch9_storage.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusb_freertos_class_audio.c
This file contains the implementation of the audio specific class code for the
example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 rb 26/03/18 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_audio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusb_freertos_class_audio.h
This file contains definitions used in the class code. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 26/03/18 First release
</pre>

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_audio.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xusb_freertos_class_composite.c This file contains the implementation of the
composite device specific class code for the example. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 28/03/18 First release
1.5 vak 13/02/19 Added support for versal 1.5 vak 03/25/19 Fixed incorrect
data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_composite.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xusb_freertos_class_composite.h This file contains definitions used in the
composite device class code. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 rb 28/03/18 First release 1.5 vak 13/02/19 Added support
for versal 1.5 vak 03/25/19 Fixed incorrect data_alignment pragma directive for
IAR </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_composite.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xusb_freertos_class_keyboard.c This file contains the implementation of the HID
specific class code for the example. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 rb 22/03/18 First release </pre> / Include Files
/

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_keyboard.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xusb_freerots_class_keyboard.h This file contains definitions used in the HID
class. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
rb 22/03/18 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_keyboard.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freerots_class_storage.c
This file contains the implementation of the Mass Storage specific class code
for the example. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 rb 22/03/18 First release 1.5 vak 13/02/19 Added support for versal
1.5 vak 03/25/19 Fixed incorrect data_alignment pragma directive for IAR </pre>
/ Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_storage.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_storage_class_storage.h
This file contains definitions used in the Mass Storage class code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 22/03/18
First release 1.5 vak 03/25/19 Fixed incorrect data_alignment pragma directive
for IAR </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_class_storage.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_composite.c
This file implements mass storage, hid, audio and dfu all in one composite
device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
rb 28/03/18 First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_composite.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_dfu.c This file
implements DFU class example. @setup requirement zcu102 board in usb device
mode, connected with host using USB 3.0 cable Following other files require to
run this example o xusb_ch9.c, xusb_ch9.h o xusb_ch9_dfu.c, xusb_ch9_dfu.h o
xusb_class_dfu.c, xusb_class_dfu.h @validation o on success example will be
detected as dfu device on host o user can download binaries using dfu-util <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 28/03/18
First release </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_dfu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusb_freertos_keyboard.c This
file implements keyboard example. @setup requirement zcu102 board in usb device
mode, connected with host using USB 3.0 cable Following other files require to
run this example o xusb_ch9.c, xusb_ch9.h o xusb_freertos_ch9_keyboard.c,
xusb_freerots_ch9_keyboard.h o xusb_freertos_class_keyboard.c,
xusb_freertos_class_keyboard.h @validation o on success example will be detected
as keyboard on host o start hexdump <hid node> on host o press key on board
serial o key should be detcted on host <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 rb 22/03/18 First release 1.5 vak 03/25/19 Fixed
incorrect data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_keyboard.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_freertos_massstorage.c
This file implements the mass storage class example. @setup requirement zcu102
board in usb device mode, connected with host using USB 3.0 cable Following
other files require to run this example o xusb_ch9.c, xusb_ch9.h o
xusb_freertos_ch9_storage.c, xusb_freerots_ch9_storage.h o
xusb_freertos_class_storage.c, xusb_freertos_class_storage.h @validation o on
success example will be detected as mass storage on host o do IN and OUT
transfer of the same size o must not get diff between IN and OUT files <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rb 22/03/18
First release 1.5 vak 13/02/19 Added support for versal 1.5 vak 03/25/19 Fixed
incorrect data_alignment pragma directive for IAR </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_freertos_massstorage.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_intr_example.c This file
implements the mass storage class example. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 sg 06/06/16 First release ms 04/10/17
Modified filename tag to include the file in doxygen examples. 1.4 BK 12/01/18
Renamed the file and added changes to have a common example for all USB IPs. vak
22/01/18 Added changes for supporting microblaze platform vak 13/03/18 Moved the
setup interrupt system calls from driver to example. 1.5 vak 13/02/19 Added
support for versal </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_poll_example.c This file
implements the mass storage class poll example. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.5 vak 06/02/19 First release 1.5 vak
03/25/19 Fixed incorrect data_alignment pragma directive for IAR </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_poll_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_wrapper.c This file
contains implementation of USBPSU Driver wrappers. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 BK 12/01/18 First release MYK
12/01/18 Added hibernation support for device mode vak 13/03/18 Moved the setup
interrupt system calls from driver to example. 1.5 vak 02/06/19 Modified the
code to add UsbPollHandler and UsbEnableEvent API's vak 02/07/19 Modified the
code to issue XUsbPsu_Ep0StallRestart() for Endpoint Zero </pre> / Include Files
/

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_wrapper.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xusb_wrapper.h This file
contains declarations for USBPSU Driver wrappers. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 BK 12/01/18 First release MYK
12/01/18 Added hibernation support for device mode vak 22/01/18 Added Microblaze
support for usbpsu driver vak 13/03/18 Moved the setup interrupt system calls
from driver to example. 1.5 vak 02/06/19 Add UsbPollHandler and UsbEnableEvent
API's </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/examples/xusb_wrapper.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu.c @addtogroup
usbpsu_v1_3 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 sg 06/16/16 First release 1.1 sg 10/24/16 Added new function
XUsbPsu_IsSuperSpeed 1.4 bk 12/01/18 Modify USBPSU driver code to fit USB common
example code for all USB IPs. myk 12/01/18 Added hibernation support for device
mode 1.4 vak 30/05/18 Removed xusb_wrapper files vak 24/09/18 Add support for
connecting to host in high-speed 1.5 vak 02/06/19 Add API for idling usb
controller pm 22/07/29 Removed coverity warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu.h @addtogroup
usbpsu_v1_3 @{ @details <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
----- -------- 1.0 sg 06/06/16 First release 1.1 sg 10/24/16 Update for backward
compatibility Added XUsbPsu_IsSuperSpeed function in xusbpsu.c 1.2 mn 01/20/17
removed unnecessary declaration of XUsbPsu_SetConfiguration in xusbpsu.h 1.2 mn
01/30/17 Corrected InstancePtr->UnalignedTx with Ept->UnalignedTx in
xusbpsu_controltransfers.c 1.2 mus 02/10/17 Updated data structures to fix
compilation errors for IAR compiler ms 03/17/17 Added readme.txt file in
examples folder for doxygen generation. ms 04/10/17 Modified filename tag to
include the file in doxygen examples. 1.4 bk 12/01/18 Modify USBPSU driver code
to fit USB common example code for all USB IPs. myk 12/01/18 Added hibernation
support for device mode vak 22/01/18 Added changes for supporting microblaze
platform vak 13/03/18 Moved the setup interrupt system calls from driver to
example. vak 24/09/18 Added EnableSuperSpeed in XUsbPsu_Config for speed
negotiation at the time of connection to Host 1.5 vak 02/06/19 Added
"xusbpsu_endpoint.h" header 1.5 vak 03/25/19 Fixed incorrect data_alignment
pragma directive for IAR pm 22/07/19 Removed coverity warnings </pre>

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu_controltransfers.c
@addtogroup usbpsu_v1_0 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 sg 06/06/16 First release 1.3 vak 04/03/17 Added CCI
support for USB 1.4 bk 12/01/18 Modify USBPSU driver code to fit USB common
example code for all USB IPs. 1.4 vak 30/05/18 Removed xusb_wrapper files </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_controltransfers.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu_endpoint.c @addtogroup
usbpsu_v1_3 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 sg 06/06/16 First release 1.3 vak 04/03/17 Added CCI support for
USB 1.4 bk 12/01/18 Modify USBPSU driver code to fit USB common example code for
all USB IPs myk 12/01/18 Added hibernation support for device mode 1.4 vak
30/05/18 Removed xusb_wrapper files pm 22/07/19 Removed coverity warnings </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_endpoint.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbps_endpoint.h @addtogroup
usbpsu_v1_3 @{ This is an internal file containing the definitions for
endpoints. It is included by the xusbps_endpoint.c which is implementing the
endpoint functions and by xusbps_intr.c. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 sg 06/06/16 First release 1.4 bk 12/01/18
Modify USBPSU driver code to fit USB common example code for all USB IPs. pm
22/07/18 Removed coverity warning- INCLUDE_RECURSION </pre> /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_endpoint.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu_hibernation.c This
patch adds hibernation support to usbpsu driver when dwc3 is operating as a
gadget <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.0
Mayank 12/01/18 First release 1.5 VAK 14/03/19 Enable hibernation related
functions only when XUSBPSU_HIBERNATION_ENABLE is defined </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_hibernation.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu_hw.h @addtogroup
usbpsu_v1_3 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.0 sg 06/06/16 First release 1.4 myk 12/01/18 Added support of
hibernation </pre>

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu_intr.c @addtogroup
usbpsu_v1_3 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 sg 06/06/16 First release 1.3 vak 04/03/17 Added CCI support for
USB 1.4 bk 12/01/18 Modify USBPSU driver code to fit USB common example code for
all USB IPs myk 12/01/18 Added hibernation support vak 22/01/18 Added changes
for supporting microblaze platform vak 13/03/18 Moved the setup interrupt system
calls from driver to example. 1.4 vak 30/05/18 Removed xusb_wrapper files </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xusbpsu_sinit.h @addtogroup
usbpsu_v1_3 @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 sg 06/06/16 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/usbpsu/src/xusbpsu_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 rco 07/21/15 Initial version of vprocss csc
subcore tcl 2.0 dmc 12/17/15 Include new args ENABLE_422 and ENABLE_WINDOW 2.2
vyc 10/04/17 Include new arg ENABLE_420

FILES:
XilinxProcessorIPLib/drivers/v_csc/data/v_csc.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_csc_l2.c @addtogroup
v_csc_v2_2 @{ @details The CSC Layer-2 Driver. The functions in this file
provides an abstraction from the register peek/poke methodology by implementing
most common use-case provided by the sub-core. See xv_csc_l2.h for a detailed
description of the layer-2 driver <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 rco 07/21/15 Initial Release 2.00 rco 11/05/15
Integrate layer-1 with layer-2 dmc 12/17/15 IsDemoWindowEnabled prevents access
to absent HW regs Corrected typo in XV_CscSetColorspace setting K31 FW reg
Updated the XV_CscDbgReportStatus routine 2.1 rco 02/09/17 Fix c++ warnings 2.2
vyc 10/04/17 Added support for 4:2:0 2.3 viv 06/19/18 Added support for color
range </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_csc/src/xv_csc_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_csc_l2.h @addtogroup
v_csc_v2_2 @{ @details This header file contains layer 2 API's of the csc sub-
core driver. The functions contained herein provides a high level implementation
of features provided by the IP, abstracting away the register level details from
the user <b>Color Space Converter IP Features </b> The CSC IP supports following
features - Set a Demo Window (user can select a sub-frame where above features
will have effect). This Demo Window is optionally included in the CSC IP. -
Supports resolution up to 4k2k 60Hz - up to 16 bits color depth - 1, 2 or 4
pixel per clock processing The Layer 2 driver of Color Space Conversion core
offers following features - Set/Get Brightness, contrast, saturation - Set/Get
Gain for R/G/B channel - Set/Get Input/Output Color Standard (BT601, BT709,
BT2020) - Set/Get Input/Output Color Format (RGB, YUV444, YUV422) - All settings
are translated between user range (0-100) and IP supported range
<b>Dependency</b> This driver makes use of the video enumerations and data types
defined in the Xilinx Video Common Driver (video_common_vX.x) and as such the
common driver must be included as dependency to compile this driver
<b>Initialization & Configuration</b> The device driver enables higher layer
software (e.g., an application) to communicate to the CSC core. Before using the
layer-2 API's user must initialize the core by calling Layer-1 API
XV_csc_Initialize(). This function will look for a configuration structure for
the device and initialize it to defined HW settings. After initialization
Layer-2 API's can be used to configure the core. It is recommended user always
make use of Layer-2 API to interact with the core Advanced users always have the
capability to directly interact with the core using Layer-1 API's that perform
low level register peek/poke. <b> Interrupts </b> This driver does not have any
interrupts <b> Virtual Memory </b> This driver supports Virtual Memory. The RTOS
is responsible for calculating the correct device base address in Virtual Memory
space. <b> Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release 2.00 rco 11/05/15 Integrate layer-1 with layer-2 dmc 12/17/15
Macros query Is422Enabled, IsDemoWindowEnabled flags that were added to the
XV_csc_Config structure 2.20 vyc 10/04/17 Macro queries Is420Enabled flag that
was added to the XV_csc_Config structure </pre>

FILES:
XilinxProcessorIPLib/drivers/v_csc/src/xv_csc_l2.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

File generated on Tue Feb 19 04:17:02 EST 2019 Vivado(TM) HLS - High-Level
Synthesis from C, C++ and SystemC v2019.1.0 (64-bit) SW Build 2453764 on Mon Feb
18 12:01:12 MST 2019 IP Build 2453739 on Mon Feb 18 14:42:34 MST 2019 Copyright
1986-2019 Xilinx, Inc. All Rights Reserved. CTRL 0x00 : Control signals bit 0 -
ap_start (Read/Write/COH) bit 1 - ap_done (Read/COR) bit 2 - ap_idle (Read) bit
3 - ap_ready (Read) bit 7 - auto_restart (Read/Write) others - reserved 0x04 :
Global Interrupt Enable Register bit 0 - Global Interrupt Enable (Read/Write)
others - reserved 0x08 : IP Interrupt Enable Register (Read/Write) bit 0 -
Channel 0 (ap_done) bit 1 - Channel 1 (ap_ready) others - reserved 0x0c : IP
Interrupt Status Register (Read/TOW) bit 0 - Channel 0 (ap_done) bit 1 - Channel
1 (ap_ready) others - reserved 0x10 : Data signal of width bit 31~0 -
width[31:0] (Read/Write) 0x14 : reserved 0x18 : Data signal of height bit 31~0 -
height[31:0] (Read/Write) 0x1c : reserved 0x20 : Data signal of read_fb_V bit
31~0 - read_fb_V[31:0] (Read/Write) 0x24 : Data signal of read_fb_V bit 31~0 -
read_fb_V[63:32] (Read/Write) 0x28 : reserved 0x30 : Data signal of colorFormat
bit 7~0 - colorFormat[7:0] (Read/Write) others - reserved 0x34 : reserved 0x38 :
Data signal of algo bit 7~0 - algo[7:0] (Read/Write) others - reserved 0x3c :
reserved 0x40 : Data signal of invert_field_id bit 0 - invert_field_id[0]
(Read/Write) others - reserved 0x44 : reserved 0x50 : Data signal of write_fb_V
bit 31~0 - write_fb_V[31:0] (Read/Write) 0x54 : Data signal of write_fb_V bit
31~0 - write_fb_V[63:32] (Read/Write) 0x58 : reserved (SC Self Clear, COR Clear
on Read, TOW Toggle on Write, COH Clear on Handshake)

FILES:
XilinxProcessorIPLib/drivers/v_deinterlacer/src/xv_deinterlacer_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_deinterlacer_l2.c
@addtogroup v_deinterlacer_v6_2 @{ @details The deint Layer-2 Driver. The
functions in this file provides an abstraction from the register peek/poke
methodology by implementing most common use-case provided by the sub-core. See
xv_deinterlacer_l2.h for a detailed description of the layer-2 driver <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.00 rco 07/21/15
Initial Release 6.00 rco 11/05/15 Integrate layer-1 with layer-2 dmc 02/25/16
add public routine XV_DeintWaitForIdle() </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_deinterlacer/src/xv_deinterlacer_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_deinterlacer_l2.h
@addtogroup v_deinterlacer_v6_2 @{ @details This header file contains layer 2
API's of the deint sub-core driver. The functions contained herein provides a
high level implementation of features provided by the IP, abstracting away the
register level details from the user <b>Deinterlacer IP Features </b> Currently
only 1080i input is supported <b>Dependency</b> This driver makes use of the
video enumerations and data types defined in the Xilinx Video Common Driver
(video_common_vX.x) and as such the common driver must be included as dependency
to compile this driver <b>Initialization & Configuration</b> The device driver
enables higher layer software (e.g., an application) to communicate to the deint
core. Before using the layer-2 API's user must initialize the core by calling
Layer-1 API XV_deinterlacer_Initialize(). This function will look for a
configuration structure for the device and initialize it to defined HW settings.
After initialization Layer-2 API's can be used to configure the core. It is
recommended user always make use of Layer-2 API to interact with core. Advanced
users always have the capability to directly interact with the core using
Layer-1 API's that perform low level register peek/poke. <b> Interrupts </b>
This driver does not have any interrupts <b> Virtual Memory </b> This driver
supports Virtual Memory. The RTOS is responsible for calculating the correct
device base address in Virtual Memory space. <b> Threads </b> This driver is not
thread safe. Any needs for threads or thread mutual exclusion must be satisfied
by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 5.00 rco 07/21/15 Initial Release 6.00 rco 11/05/15
Integrate layer-1 with layer-2 dmc 02/25/16 add public routine
XV_DeintWaitForIdle() 6.1 rco 11/07/16 Fix for c++ compile </pre>

FILES:
XilinxProcessorIPLib/drivers/v_deinterlacer/src/xv_deinterlacer_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. \file vdemosaic_example.tcl Automates
the process of generating the downloadable bit & elf files from the provided
example hdf file. Documented procedure \c vdemosaic_example . The code is
inserted here: \code

FILES:
XilinxProcessorIPLib/drivers/v_demosaic/examples/vdemosaic_example.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file main.c This file demonstrates
the example usage of Frame Buffer Read IP available in catalogue. Please refer
v_frmbuf_rd example design guide for details on HW setup. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 vyc 04/05/17 Initial
Release 2.00 vyc 10/04/17 Add second buffer pointer for semi-planar formats Add
new memory formats BGRX8 and UYVY8 3.00 vyc 04/04/18 Add support for ZCU102,
ZCU104, ZCU106 Add new memory format BGR8 4.00 pv 11/10/18 Added flushing
feature support in driver. flush bit should be set and held (until reset) by
software to flush pending transactions.IP is expecting a hard reset, when
flushing is done.(There is a flush status bit and is asserted when the flush is
done). 4.10 vv 03/13/19 Added new pixel formats with 12 and 16 bpc. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_rd/examples/src/xv_frmbufrd_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

CAUTION: This file is automatically generated by HSI. Version: 2018.3 DO NOT
EDIT. All Rights Reserved. Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated documentation files (the
Software), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED AS IS,
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: Driver configuration

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_rd/src/xv_frmbufrd_g.c
XilinxProcessorIPLib/drivers/v_frmbuf_wr/src/xv_frmbufwr_g.c
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_frmbufrd_l2.c @addtogroup
v_frmbuf_rd_v2_0 @{ Frame Buffer Read Layer-2 Driver. The functions in this file
provides an abstraction from the register peek/poke methodology by implementing
most common use-case provided by the sub-core. See xv_frmbufrd_l2.h for a
detailed description of the layer-2 driver <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 vyc 04/05/17 Initial Release 2.00 vyc
10/04/17 Add second buffer pointer for semi-planar formats Add memory formats
RGBA8, YUVA8, BGRA8, BGRX8, UYVY8 3.00 vyc 04/04/18 Add interlaced support Add
new memory format BGR8 Add interrupt handler for ap_ready 4.00 pv 11/10/18 Added
flushing feature support in driver. flush bit should be set and held (until
reset) by software to flush pending transactions.IP is expecting a hard reset,
when flushing is done.(There is a flush status bit and is asserted when the
flush is done). 4.10 vv 02/05/19 Added new pixel formats with 12 and 16 bpc.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_rd/src/xv_frmbufrd_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_frmbufrd_l2.h @addtogroup
v_frmbuf_rd_v2_0 @{ @details This header file contains layer 2 API's of the
frame buffer read core driver. The functions contained herein provides a high
level implementation of features provided by the IP, abstracting away the
register level details from the user <b>Frame Buffer Read IP Features </b> The
Frame Buffer Read IP supports following features - AXI4-Stream Output - 1, 2, or
4 pixel-wide video interface - 8/10 bits per component - Up to 19 different
memory color formats (user configurable) <b>Dependency</b> This driver makes use
of the video enumerations and data types defined in the Xilinx Video Common
Driver (video_common_vX.x) and as such the common driver must be included as
dependency to compile this driver <b>Initialization & Configuration</b> The
device driver enables higher layer software (e.g., an application) to
communicate with the frame buffer read core. Driver is built with layered
architecture - Layer 1 provides API's to peek/poke registers at HW level. -
Layer 2 provides API's that abstract sub-core functionality, providing an easy
to use feature interface Before using the layer-2 API's user must initialize the
core by calling API XVFrmbufRd_Initialize(). This function will look for a
configuration structure for the device and initialize it to defined HW settings.
It is recommended user always make use of Layer-2 API to interact with this
core. Advanced users always have the capability to directly interact with the IP
core using Layer-1 API's that perform low level register peek/poke. <b>Pre-
Requisite's</b> - Application must set the memory address using provided API
Address must be aligned to memory width. This can be computed with following
equation Align 2 PPC 4 Bytes (where PPC is the Pixels/Clock selected in IP
configuration) - The Stride must be provided in Bytes and must be aligned to
memory width. This can be computed with following equation StrideInBytes 2 PPC 4
Bytes (where PPC is the Pixels/Clock selected in IP configuration) <b>
Interrupts </b> Driver is configured to operate both in polling as well as
interrupt mode. - To use interrupt based processing, application must set up the
system's interrupt controller and connect the XVFrmbufRd_InterruptHandler
function to service interrupts. Next interrupts must be enabled using the
provided API. When an interrupt occurs, ISR will confirm if frame processing is
is done/ready. If call back is registered such function will be called and
application can apply new setting updates here. Subsequently next frame
processing will be triggered with new settings. - To use polling method disable
interrupts using the provided API. Doing so will configure the IP to keep
processing frames without sw intervention. - Polling mode is the default
configuration set during driver initialization <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 vyc 04/05/17 Initial Release 2.00 vyc
10/04/17 Add second buffer pointer for semi-planar formats Add memory formats
RGBA8, YUVA8, BGRA8, BGRX8, UYVY8 3.00 vyc 04/04/18 Add interlaced support Add
new memory format BGR8 Add interrupt handler for ap_ready 4.10 vv 02/05/19 Added
new pixel formats with 12 and 16 bpc. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_rd/src/xv_frmbufrd_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_frmbufrd_l2_intr.c
@addtogroup v_frmbuf_rd_v2_0 @{ The functions in this file provides interrupt
handler and associated functions that are consumed by layer-2 <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 vyc 04/05/17 Initial
Release 3.00 vyc 04/04/18 Add interrupt handler for ap_ready </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_rd/src/xv_frmbufrd_l2_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file main.c This file demonstrates
the example usage of Frame Buffer Read/Write IP available in catalogue. Please
refer v_frmbuf_wr example design guide for details on HW setup. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 vyc 04/05/17
Initial Release 2.00 vyc 10/04/17 Add second buffer pointer for semi-planar
formats Add new memory formats BGRX8 and UYVY8 3.00 vyc 04/04/18 Add support for
ZCU102, ZCU104, ZCU106 Add new memory format BGR8 4.00 pv 11/10/18 Added
flushing feature support in driver. flush bit should be set and held (until
reset) by software to flush pending transactions.IP is expecting a hard reset,
when flushing is done.(There is a flush status bit and is asserted when the
flush is done). 4.10 vv 02/05/19 Added new pixel formats with 12 and 16 bpc.
</pre>

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_wr/examples/src/xv_frmbufwr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_frmbufwr_l2.c @addtogroup
v_frmbuf_wr_v2_0 @{ Frame Buffer Write Layer-2 Driver. The functions in this
file provides an abstraction from the register peek/poke methodology by
implementing most common use-case provided by the sub-core. See xv_frmbufwr_l2.h
for a detailed description of the layer-2 driver <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 vyc 04/05/17 Initial Release 2.00 vyc
10/04/17 Add second buffer pointer for semi-planar formats Add new memory
formats BGRX8 and UYVY8 3.00 vyc 04/04/18 Add interlaced support Add new memory
format BGR8 Add interrupt handler for ap_ready 4.00 pv 11/10/18 Added flushing
feature support in driver. flush bit should be set and held (until reset) by
software to flush pending transactions.IP is expecting a hard reset, when
flushing is done.(There is a flush status bit and is asserted when the flush is
done). 4.10 vv 02/05/19 Added new pixel formats with 12 and 16 bpc. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_wr/src/xv_frmbufwr_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_frmbufwr_l2.h @addtogroup
v_frmbuf_wr_v2_0 @{ @details This header file contains layer 2 API's of the
frame buffer write core driver. The functions contained herein provides a high
level implementation of features provided by the IP, abstracting away the
register level details from the user <b>Frame Buffer Write IP Features </b> The
Frame Buffer Write IP supports following features - AXI4-Stream Input - 1, 2, or
4 pixel-wide video interface - 8/10 bits per component - Up to 16 different
memory color formats (user configurable) <b>Dependency</b> This driver makes use
of the video enumerations and data types defined in the Xilinx Video Common
Driver (video_common_vX.x) and as such the common driver must be included as
dependency to compile this driver <b>Initialization & Configuration</b> The
device driver enables higher layer software (e.g., an application) to
communicate with the frame buffer write core. Driver is built with layered
architecture - Layer 1 provides API's to peek/poke registers at HW level. -
Layer 2 provides API's that abstract sub-core functionality, providing an easy
to use feature interface Before using the layer-2 API's user must initialize the
core by calling API XVFrmbufWr_Initialize(). This function will look for a
configuration structure for the device and initialize it to defined HW settings.
It is recommended user always make use of Layer-2 API to interact with this
core. Advanced users always have the capability to directly interact with the IP
core using Layer-1 API's that perform low level register peek/poke. <b>Pre-
Requisite's</b> - Application must set the memory address using provided API
Address must be aligned to memory width. This can be computed with following
equation Align 2 PPC 4 Bytes (where PPC is the Pixels/Clock selected in IP
configuration) - The Stride must be provided in Bytes and must be aligned to
memory width. This can be computed with following equation StrideInBytes 2 PPC 4
Bytes (where PPC is the Pixels/Clock selected in IP configuration) <b>
Interrupts </b> Driver is configured to operate both in polling as well as
interrupt mode. - To use interrupt based processing, application must set up the
system's interrupt controller and connect the XVFrmbufWr_InterruptHandler
function to service interrupts. Next interrupts must be enabled using the
provided API. When an interrupt occurs, ISR will confirm if frame processing is
is done/ready. If call back is registered such function will be called and
application can apply new setting updates here. Subsequently next frame
processing will be triggered with new settings. - To use polling method disable
interrupts using the provided API. Doing so will configure the IP to keep
processing frames without sw intervention. - Polling mode is the default
configuration set during driver initialization <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 vyc 04/05/17 Initial Release 2.00 vyc
10/04/17 Add second buffer pointer for semi-planar formats Add new memory
formats BGRX8 and UYVY8 3.00 vyc 04/04/18 Add interlaced support Add new memory
format BGR8 Add interrupt handler for ap_ready 4.10 vv 02/05/19 Added new pixel
formats with 12 and 16 bpc. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_wr/src/xv_frmbufwr_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xv_frmbufwr_l2_intr.c @addtogroup v_frmbuf_wr_v2_0 @{ The functions in this file
provides interrupt handler and associated functions that are consumed by layer-2
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 vyc
04/05/17 Initial Release 3.00 vyc 04/04/18 Add interrupt handler for ap_ready
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_frmbuf_wr/src/xv_frmbufwr_l2_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hcresampler_coeff.c
@addtogroup v_hcresampler_v3_0 @{ @details This file provides the default fixed
coefficient sets for supported taps <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 rco 07/31/15 Initial Release 3.0 rco 02/09/17
Fix c++ compilation warnings </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hcresampler/src/xv_hcresampler_coeff.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hcresampler_l2.c @addtogroup
v_hcresampler_v3_0 @{ @details The Horizontal Chroma Resampler Layer-2 Driver.
The functions in this file provides an abstraction from the register peek/poke
methodology by implementing most common use-case provided by the sub-core. See
xv_hcresampler_l2.h for a detailed description of the layer-2 driver <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release 2.00 rco 11/05/15 Integrate layer-1 with layer-2 2.10 rco
07/20/16 Add passthrough mode support rco 02/09/17 Fix c++ compilation warnings
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hcresampler/src/xv_hcresampler_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hcresampler_l2.h @addtogroup
v_hcresampler_v3_0 @{ @details This header file contains layer 2 API's of the
horizontal chroma resampler sub-core driver.The functions contained herein
provides a high level implementation of features provided by the IP, abstracting
away the register level details from the user <b>H Chroma Resampler IP Features
</b> The horizontal chroma resampler IP supports following features - convert
YUV422 -> YUV444 and YUV444 -> YUV422 - Supports resolution up to 4k2k 60Hz - up
to 16 bits color depth - 1, 2 or 4 pixel per clock processing <b>Dependency</b>
This driver makes use of the video enumerations and data types defined in the
Xilinx Video Common Driver (video_common_vX.x) and as such the common driver
must be included as dependency to compile this driver <b>Initialization &
Configuration</b> The device driver enables higher layer software (e.g., an
application) to communicate to the hcresampler core. Before using the layer-2
API's user must initialize the core by calling Layer-1 API
XV_hcresampler_Initialize(). This function will look for a configuration
structure for the device and initialize it to defined HW settings. After
initialization Layer-2 API's can be used to configure the core. It is
recommended user always make use of Layer-2 API to interact with this core.
Advanced users always have the capability to directly interact with the IP core
using Layer-1 API's that perform low level register peek/poke. <b> Interrupts
</b> This driver does not have any interrupts <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 rco 07/21/15 Initial Release 2.00 rco
11/05/15 Integrate layer-1 with layer-2 </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hcresampler/src/xv_hcresampler_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmic.c @addtogroup
hdmi_common_v1_0 @{ Contains common utility functions that are typically used by
hdmi-related drivers and applications. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 EB 21/12/17 Initial release. 1.1 EB
10/04/18 Fixed a bug in XV_HdmiC_ParseAudioInfoFrame </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmi_common/src/xv_hdmic.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmic.h @addtogroup
hdmi_common_v1_0 @{ @details Contains common structures, definitions, macros,
and utility functions that are typically used by hdmi-related drivers and
applications. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 EB 21/12/17 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmi_common/src/xv_hdmic.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmic_vsif.c Contains function
definitions related to Vendor Specific InfoFrames used in HDMI. Please see
xhdmic_vsif.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.00 yh 15/01/15 Initial release for 3D
video support 1.01 YH 2017/07/19 Clean up Print Statement line ending to "\r\n"
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmi_common/src/xv_hdmic_vsif.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmic_vsif.h This is the main
header file for Vendor Specific InfoFrames used in HDMI. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 yh 15/01/15 Initial
release for 3D video support </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmi_common/src/xv_hdmic_vsif.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- dd/mm/yy -------- ------ -------- 1.0 gm
10/12/18 Initial release.

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/data/v_hdmiphy1.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1.c Contains a minimal
set of functions for the XHdmiphy1 driver that allow access to all of the Video
PHY core's functionality. See xhdmiphy1.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1.h @addtogroup
xhdmiphy1_v1_0 @{ @details This is main header file of the Xilinx HDMI PHY
Controller driver <b>Video PHY Controller Overview</b> The PHY is intended to
simplify the use of serial transceivers and adds domain-specific
configurability. The Video PHY Controller IP is not intended to be used as a
stand alone IP and must be used with Xilinx Video MACs such as HDMI 2.1
Transmitter/Receiver Subsystems. The core enables simpler connectivity between
MAC layers for TX and RX paths. However, it is still important to understand the
behavior, usage, and any limitations of the transceivers. See the device
specific transceiver user guide for details. <b>Video PHY Controller Driver
Features</b> Video PHY Controller driver supports following features - Xilinx
HDMI 2.1 MAC IP - GTHE3, GTHE4 and GTYE4 GT types - HDMI: - 4 pixel-wide video
interface - 8/10/12 bits per component - RGB & YCbCr color space - Up to 10k
resolution at both Input and Output interface <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm
10/12/18 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_gt.h The Xilinx HDMI
PHY (HDMIPHY) driver. This driver supports the Xilinx HDMI PHY IP core. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial release. </pre> @addtogroup
xhdmiphy1_v1_0 @{

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_gt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_gthe3.c Contains a
minimal set of functions for the XHdmiphy1 driver that allow access to all of
the Video PHY core's functionality. See xhdmiphy1.h for a detailed description
of the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_gthe3.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_gthe4.c Contains a
minimal set of functions for the XHdmiphy1 driver that allow access to all of
the Video PHY core's functionality. See xhdmiphy1.h for a detailed description
of the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_gthe4.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_gtye4.c Contains a
minimal set of functions for the XHdmiphy1 driver that allow access to all of
the Video PHY core's functionality. See xhdmiphy1.h for a detailed description
of the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_gtye4.c
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_gtye5.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_hdmi.c This file
contains video PHY functionality specific to the HDMI protocol. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- dd/mm/yy
----- ---- -------- 1.0 gm 10/12/18 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_hdmi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_hdmi.h The Xilinx
HDMI PHY (HDMIPHY) driver. This driver supports the Xilinx HDMI PHY IP core.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial release. </pre> @addtogroup
xhdmiphy1_v1_0 @{

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_hdmi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_hdmi_intr.c This file
contains video PHY functionality specific to the HDMI protocol related to
interrupts. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial release.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_hdmi_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_hw.h This header file
contains the identifiers and low-level driver functions (or macros) that can be
used to access the device. High-level driver functions are defined in
xhdmiphy1.h. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial release.
</pre> @addtogroup xhdmiphy1_v1_0 @{

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_i.c Contains generic
APIs that are locally called or used within the HDMIPHY driver. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- dd/mm/yy
----- ---- -------- 1.0 gm 10/12/18 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_i.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_i.h Contains generic
APIs that are locally called or used within the HDMIPHY driver. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- Ver Who
Date Changes ----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18
Initial release. </pre> @addtogroup xhdmiphy1_v1_0 @{

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_intr.c This file
contains functions related to XHdmiphy1 interrupt handling. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- dd/mm/yy -----
---- -------- 1.0 gm 10/12/18 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1.c
Contains a minimal set of functions for the XHdmiphy1 driver that allow access
to all of the Video PHY core's functionality. See xhdmiphy1.h for a detailed
description of the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_log.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_mmcme3.c Contains a
minimal set of functions for the XHdmiphy1 driver that allow access to all of
the Video PHY core's functionality. See xhdmiphy1.h for a detailed description
of the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_mmcme3.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_mmcme4.c Contains a
minimal set of functions for the XHdmiphy1 driver that allow access to all of
the Video PHY core's functionality. See xhdmiphy1.h for a detailed description
of the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_mmcme4.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_mmcme5.c Contains a
minimal set of functions for the XHdmiphy1 driver that allow access to all of
the Video PHY core's functionality. See xhdmiphy1.h for a detailed description
of the driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- dd/mm/yy ----- ---- -------- 1.0 gm 10/12/18 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_mmcme5.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_selftest.c This file
contains a diagnostic self-test function for the XHdmiphy1 driver. It will check
many of the Video PHY's register values against the default reset values as a
sanity-check that the core is ready to be used. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- dd/mm/yy ----- ---- --------
1.0 gm 10/12/18 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmiphy1_sinit.c This file
contains static initialization methods for the XHdmiphy1 driver. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- dd/mm/yy
----- ---- -------- 1.0 gm 10/12/18 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmiphy1/src/xhdmiphy1_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx.c This is the main
file for Xilinx HDMI RX core. Please see xv_hdmirx.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 gm, mg 11/03/15 Initial release. 1.01 MG 30/12/15 Added DDC HDCP 2.2 calls
1.02 yh 15/01/16 Added 3D Video support 1.03 MG 19/02/16 Added link error
callback 1.04 MG 08/03/16 Updated XV_HdmiRx_SetStream to use RefClk 1.05 MG
27/05/16 Updated XV_HdmiRx_CfgInitialize 1.06 YH 18/07/16 Replace xil_printf
with xdbg_printf 1.07 YH 25/07/16 Used UINTPTR instead of u32 for BaseAddress
XV_HdmiRx_CfgInitialize 1.08 YH 18/08/16 squash unused variable compiler warning
1.09 YH 29/08/16 Set Match to FALSE when HTotal 0 1.10 MG 02/03/17 Fixed YUV420
reading in function XV_HdmiRx_GetVideoTiming 1.40 YH 19/07/17 Clean up Print
Statement line ending to "\r\n" 05/09/17 Enhanced Video Timing checking 2.00 YH
16/11/17 Added dedicated reset for each clock domain YH 16/11/17 Added bridge
overflow interrupt EB 18/01/18 Moved VicTable to Hdmi Common library EB 26/01/18
Updated XV_HdmiRx_GetVideoTiming to use XVidC_GetVideoModeIdExtensive 2.20 EB
16/08/18 Replaced TIME_10MS, TIME_16MS, TIME_200MS with XV_HdmiRx_GetTime10Ms,
XV_HdmiRx_GetTime16Ms XV_HdmiRx_GetTime200Ms Added TMDS Clock Ratio callback
support 2.30 EB 05/03/19 Updated the description of the API
XV_HdmiRx_GetLinkStatus </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx.h This is the main
header file for Xilinx HDMI RX core. HDMI RX core is used for extracting the
video and audio streams from HDMI stream. It consists of - Receiver core -
AXI4-Stream to Video Bridge - Video Timing Controller and - High-bandwidth
Digital Content Protection (HDCP) (Optional) - Data Recovery Unit (DRU)
(Optional). Receiver core performs following operations: - Aligns incoming data
stream to the word boundary and removes inter channel skew. - Unscrambles the
data if data rates above the 3.4 Gps. Otherwise bypasses the Scrambler. - Splits
the data stream into video and packet data streams. - Optional data streams
decrypt by an external HDCP module. - Decodes TMDS data into video data. -
Converts the pixel data from the link domain into the video domain. AXI Video
Bridge converts the captured native video to AXI stream and outputs the video
data through the AXI video interface. Video Timing Controller (VTC) measures the
video timing. Data Recovery Unit (DRU) to recover the data from the HDMI stream
if incoming HDMI stream is too slow for the transceiver. <b>Core Features </b>
For a full description of HDMI RX features, please see the hardware
specification. <b>Software Initialization & Configuration</b> The application
needs to do following steps in order for preparing the HDMI RX core to be ready.
- Call XV_HdmiRx_LookupConfig using a device ID to find the core configuration.
- Call XV_HdmiRx_CfgInitialize to initialize the device and the driver instance
associated with it. <b>Interrupts </b> This driver provides interrupt handlers -
XV_HdmiRx_IntrHandler, for handling the interrupts from the HDMI RX core
peripherals. Application developer needs to register interrupt handler with the
processor, within their examples. Whenever processor calls registered
application's interrupt handler associated with interrupt id, application's
interrupt handler needs to call appropriate peripheral interrupt handler reading
peripheral's Status register. This driver provides XV_HdmiRx_SetCallback API to
register functions with HDMI RX core instance. <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b> Building the driver </b> The HDMI RX
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 gm, mg 10/07/15 Initial
release. 1.01 yh 14/01/16 Added Marco for AxisEnable PIO 1.02 yh 15/01/16 Added
3D Video support 1.03 MG 18/02/16 Added link error callback. 1.04 MG 08/03/16
Added RefClk to structure XV_HdmiRx_Stream 1.05 MG 13/05/16 Added
XV_HdmiRx_DdcHdcp22Mode and XV_HdmiRx_DdcHdcp14 Mode macros 1.06 MG 27/05/16
Added VTD timebase macro 1.07 YH 25/07/16 Used UINTPTR instead of u32 for
BaseAddress XV_HdmiRx_Config XV_HdmiRx_CfgInitialize 1.08 YH 14/11/16 Added
XV_HdmiRx_Bridge_yuv420 & XV_HdmiRx_Bridge_pixel mode macros 1.09 MMO 02/03/17
Added Sync Loss and IsMode Handler for HDCP compliance test. 1.10 EB 24/10/17
Added enum XV_HdmiRx_AudioFormatType for AudFormat 2.00 YH 16/11/17 Added
dedicated reset for each clock domain Added bridge overflow interrupt EB
18/01/18 Moved VicTable, XV_HdmiRx_Aux to Hdmi Common library Moved Vendor
Specific InfoFrame related functions to HDMI Common library Deprecating
XV_HdmiRx_VSIF_ParsePacket, XV_HdmiRx_VSIF_DisplayInfo,
XV_HdmiRx_VSIF_3DStructToString, XV_HdmiRx_VSIF_3DSampMethodToString and
XV_HdmiRx_VSIF_3DSampPosToString APIs MMO 08/02/18 Added XV_HdmiRx_SyncStatus
enumaration, and as an element in XV_HdmiRx_Stream for Sync Loss handling 2.20
EB 16/08/18 Replaced TIME_10MS, TIME_16MS, TIME_200MS with
XV_HdmiRx_GetTime10Ms, XV_HdmiRx_GetTime16Ms XV_HdmiRx_GetTime200Ms Added TMDS
Clock Ratio callback support YB 15/08/18 Added new callbacks for HDCP 1.4 & 2.2
protocol events. Enumerated new entries for HDCP 1.4 & 2.2 protocol events in
XV_HdmiRx_HandlerType enum. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx_hw.h This header file
contains identifiers and register-level core functions (or macros) that can be
used to access the Xilinx HDMI RX core. For more information about the operation
of this core see the hardware specification and documentation in the higher
level driver xv_hdmirx.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 gm, mg 11/03/15 Initial release. 1.01 MG 30/12/15
Added DDC peripheral HDCP 2.2 masks 1.02 yh 14/01/16 Added Bit Masking for
AxisEnable PIO 1.03 MG 18/02/16 Added AUX peripheral error event mask 1.04 MG
13/05/16 Added DDC HDCP mode mask 1.05 MG 27/05/16 Added VTD timebase 1.06 MH
26/07/16 Added DDC HDCP protocol event. 1.07 YH 25/07/16 Used UINTPTR instead of
u32 for BaseAddress XV_HdmiRx_WriteReg XV_HdmiRx_ReadReg 1.08 YH 14/11/16 Added
BRIDGE_YUV420 and BRIDGE_PIXEL mask to PIO Out 1.09 MMO 02/03/17 Added
XV_HDMIRX_VTD_CTRL_SYNC_LOSS_MASK and XV_HDMIRX_VTD_STA_SYNC_LOSS_EVT_MASK for
HDCP compliance 2.00 EB 15/11/17 Added XV_HDMIRX_AUX_STA_GCP_CD_EVT_MASK YH
16/11/17 Added PIO_IN for bridge overflow interrupt 16/11/17 Added PIO_OUT for
dedicated reset for each clock domain </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx_intr.c This file
contains interrupt related functions for Xilinx HDMI RX core. Please see
xv_hdmirx.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 gm, mg 11/03/15 Initial release. 1.01 yh
14/01/16 Set AxisEnable PIO to high when RX stream locked 1.03 MG 18/02/16 Added
Link Check callback 1.04 MG 08/03/16 Added pixel clock calculation to
HdmiRx_TmrIntrHandler 1.05 MH 08/03/16 Added support for read not complete DDC
event 1.06 MG 27/05/16 Updated HdmiRx_VtdIntrHandler 1.07 MG 27/05/16 Updated
HdmiRx_TmrIntrHandler 1.08 MG 30/05/16 Fixed issue with pixel clock adjustment
for YUV422 colorspace 1.09 MH 26/07/16 Added DDC HDCP protocol event. 1.10 YH
18/08/16 squash unused variable compiler warning 1.11 MG 03/03/17 Updated
function HdmiRx_TmrIntrHandler with GetVideoPropertiesTries 1.12 YH 22/08/17
Update AudFormat when servicing Aud Interrupt 1.13 MH 31/08/17 Update Reset
sequence for Video_Bridge 2.00 EB 16/01/18 Added clearing of
XV_HDMIRX_AUX_STA_GCP_CD_EVT flag after servicing it YH 16/11/17 Added bridge
overflow interrupt 16/11/17 Update Reset sequence with dedicated reset for each
clock domain MMO 08/02/18 Adding proper handling for Sync Loss/Sync Recover 2.10
YH 13/04/18 Fixed a bug in PioIntrHandler 2.20 EB 16/08/18 Replaced TIME_10MS,
TIME_16MS, TIME_200MS with XV_HdmiRx_GetTime10Ms, XV_HdmiRx_GetTime16Ms
XV_HdmiRx_GetTime200Ms Added TMDS Clock Ratio callback support YB 15/08/18 Added
new cases for HDCP 1.4 & 2.2 protocol events in XV_HdmiRx_SetCallback function.
Updated the HdmiRx_DdcIntrHandler() function. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx_selftest.c This file
contains self test function for the HDMI RX core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 gm, mg 10/07/15 Initial release.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx_sinit.c This file
contains static initialization method for Xilinx HDMI RX core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 gm, mg
10/07/15 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx_vsif.c Contains
function definitions related to Vendor Specific InfoFrames used in HDMI. Please
see xv_hdmirx_vsif.h for more details of the driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- --- ---------- X.XX XX YYYY/MM/DD ... 1.00 RHe
2015/10/06 Initial release. 1.01 YH 2017/07/19 Clean up Print Statement line
ending to "\r\n" 2.00 EB 2018/01/23 This file is deprecated. All the APIs are
now moved to HDMI Common library </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx_vsif.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirx_vsif.h This is the
main header file for Vendor Specific InfoFrames used in HDMI. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- ---------- X.XX XX YYYY/MM/DD ... 1.00
RHe 2015/10/06 Initial release. 2.00 EB 2018/01/23 This file is deprecated. All
the APIs are now moved to HDMI Common library </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirx/src/xv_hdmirx_vsif.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, andor sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions: The above
copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 gmagnay 08/14/15 Initial version of
subsystem tcl 1.1 yh 20/01/16 Added remapper subcore, axi_gpio is to reset
remapper (hls core) 1.2 MG 03/03/16 Added HDCP 2.2 1.3 YH 30/07/16 No HDCP22_SS
sub-cores included in _g.c generation 1.4 YH 16/11/16 Remove subcore remapper &
axi_gpio 1.5 MMO 03/01/16 Added sub-core base address computation in TCL 1.6 MMO
3/01/17 Fix the TCL to support multiple instance and sync with
XV_HdmiTxSs_Config Data Structure 1.7 MM0 13/02/17 Fix by adding typecasting for
C++ Fix

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/data/v_hdmirxss.tcl
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Byte-oriented AES-256 implementation. All lookup tables replaced with 'on the
fly' calculations. Copyright (c) 2007-2011 Ilya O. Levin,
http://www.literatecode.com Other contributors: Hal Finney Permission to use,
copy, modify, and distribute this software for any purpose with or without fee
is hereby granted, provided that the above copyright notice and this permission
notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR
DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL AUTHOR BE LIABLE
FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/aes256.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/aes256.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/aes256.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/aes256.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

Byte-oriented AES-256 implementation. All lookup tables replaced with 'on the
fly' calculations. Copyright (c) 2007-2009 Ilya O. Levin,
http://www.literatecode.com Other contributors: Hal Finney Permission to use,
copy, modify, and distribute this software for any purpose with or without fee
is hereby granted, provided that the above copyright notice and this permission
notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR
DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL AUTHOR BE LIABLE
FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/aes256.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/aes256.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/aes256.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/aes256.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/aes256.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/aes256.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/aes256.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/aes256.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/aes256.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/aes256.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/aes256.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/aes256.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp22_common.h This file
contains common functions shared between HDCP22 drivers. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 MH 10/30/15 First
Release. 1.01 MH 01/15/16 Added prefix to function names. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/hdcp_key_utility/xhdcp22_common.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/hdcp_key_utility/xhdcp22_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file audiogen_drv.c This file
contains ... <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
---------- X.XX XX YYYY/MM/DD ... 1.00 RHe 2014/12/00 First release 1.1 RHe
2015/07/30 Updated ACR GetNVal to be dependent of the TMDS character rate
instead of the video mode. 1.2 NA 2017/04/28 Made Audio PLL settings into a
table for easy editing. Updated SetSampleRate to actually return an error when
something fails along the way. Updated XhdmiAudGen_SetAudClkParam() to use the
PLL settings table. Updated XhdmiAudGen_AudClkConfig() to not hang the system
when PLL fails to get in lock and return an error in that case. Also added the
fractional parts of the PLL settings. 1.3 RHe 2017/07/31 Updated ACR CTS
generation for HDMI 2.0 formats. 1.4 MMO 2017/09/05 Replace U32 with UINTPTR for
64 Bit Addressing Support 1.5 Yas 2019/03/08 Updated the ACR_N_Table values
</pre> /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/audiogen_drv.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/audiogen_drv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file audiogen_drv.h This file
contains .. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
---------- X.XX XX YYYY/MM/DD ... 1.00 RHe 2014/12/00 First release 1.1 RHe
2015/07/30 Updated ACR GetNVal to be dependent of the TMDS character rate
instead of the video mode. 1.2 NA 2017/04/28 Updated the XhdmiAudioGen_PLL_t
struct to be able to set fractional multipliers and dividers. 1.3 RHe 2017/07/31
Updated ACR CTS generation for HDMI 2.0 formats. 1.4 MMO 2017/09/05 Replace U32
with UINTPTR for 64 Bit Addressing Support </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/audiogen_drv.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/I2S/audiogen_drv.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/audiogen_drv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. DP159 Written by Marco Groeneveld All
rights reserved. History v1.0 - Initial release v1.1 - Updated DP159 setting to
automatic redriver to retimer for HDMI 1.4 data rates v1.2 - Added Reset to I2C
controller before issuing new transaction v1.3 - Changed printf usage to
xil_printf v1.4 - Update vswing setting to recommened values to pass compliance
v1.5 - Update the register setting sequence to write 0x0A the last to set
APPLY_RXTX_CHANGES

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/dp159.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/dp159.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

@file idt_8t49n24x.c @addtogroup IDT_8T49N24x @{ <pre> Copyright (c) 2016 Adeas
B.V. All rights reserved. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported
version from the 8T49N28X-FrequencyProgrammingGuide register-calculations.py
script 2.00 MG 16/08/15 Major update 2.10 MG 16/09/05 Added LOS variable 2.20 GM
18/02/08 Converted math.h functions (e.g. ceil) to standard functions </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/idt_8t49n24x.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

@file idt_8t49n24x.h @addtogroup IDT_8T49N24x @{ <pre> Copyright (c) 2016 Adeas
B.V. All rights reserved. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported
version from the 8T49N28X-FrequencyProgrammingGuide register-calculations.py
script 2.00 MG 16/08/15 Major update 2.10 MG 16/09/05 Added LOS variable 2.20 GM
18/02/08 Converted math.h functions (e.g. ceil) to standard functions </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/hdcp_key_utility/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/hdcp_key_utility/idt_8t49n24x.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Filename: sha256.c Author: Brad Conte (brad AT bradconte.com) Copyright:
Disclaimer: This code is presented "as is" without any guarantees. Details:
Implementation of the SHA-256 hashing algorithm. SHA-256 is one of the three
algorithms in the SHA2 specification. The others, SHA-384 and SHA-512, are not
offered in this implementation. Algorithm specification can be found here:
http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf
This implementation uses little endian byte order. HEADER FILES /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/sha256.c
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/sha256.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/sha256.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/sha256.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Filename: sha256.h Author: Brad Conte (brad AT bradconte.com) Copyright:
Disclaimer: This code is presented "as is" without any guarantees. Details:
Defines the API for the corresponding SHA1 implementation.

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/sha256.h
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/sha256.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/sha256.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/sha256.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file si5324drv.c This file contains
low-level driver functions for controlling the SiliconLabs Si5324 clock
generator as mounted on the KC705 demo board. The user should refer to the
hardware device specification for more details of the device operation. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- ---------- 1.00 hf
2014/10/10 First release 1.10 MG 2016/07/05 Updated LOCKT register 1.11 YH
2016/09/14 Add option to enable fast switching 1.12 YH 2017/07/19 Added SI5324
control using PS IIC 1.13 GM 2017/11/15 Issued powerdown on CLKIN1 & CLKIN2
depending on Free Run Mode to force correct clock selection </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/si5324drv.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/si5324drv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file si5324drv.h This file contains
definitions for low-level driver functions for controlling the SiliconLabs
Si5324 clock generator as mounted on the KC705 demo board. The user should refer
to the hardware device specification for more details of the device operation.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- ---------- 1.00 hf
2014/10/10 First release 1.1 gm 2017/06/23 Added Si5324_Reset in API declaration
yh 2017/07/19 Added SI5324 control using PS IIC </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/si5324drv.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/si5324drv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_hdcp_keys.c This file
contains the Xilinx HDCP key loading utility implementation as used in the HDMI
example design. Please see xhdmi_hdcp_keys.h for more details. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- ---------- 1.0 MG
26-01-2016 Initial release 1.1 YH 04-08-2016 Bypass HDCP Key password for VIPER
run in board farm 1.2 GM 12-07-2017 Changed printf usage to xil_printf Changed
"\n\r" in xil_printf calls to "\r\n" </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/xhdmi_hdcp_keys.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/xhdmi_hdcp_keys.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_hdcp_keys.h This is the
main header file for the Xilinx HDCP key loading utility used in the HDMI
example design. The HDCP cores are used for content protection according to the
HDCP 1.4 and HDCP 2.2 specifications. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- ---------- 1.0 MG 26-01-2016 Initial version </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/xhdmi_hdcp_keys.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/xhdmi_hdcp_keys.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_hdcp_keys_table.h <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- ---------- 1.0 20-02-2018
Initial version </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/xhdmi_hdcp_keys_table.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/xhdmi_hdcp_keys_table.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp.c This file contains the
main implementation of the Xilinx HDCP abstraction layer. The HDCP abstraction
layer can support repeater topologies with a single upstream interface and up to
32 downstream interfaces. Both HDCP 1.4 and 2.2 protocols are supported. The
interactions between the repeater upstream and downstream interface are
implemented in the HDCP abstraction layer including: upstream topology
propagation, and downstream stream management propagation. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 MH 05/24/16 First Release
1.10 MG 10/21/16 Updated the Hdcp_Poll function 1.20 MG 10/26/16 Added interval
in Hdcp_Poll function 1.30 MH 06/16/17 Removed authentication request flag. GM
07/12/17 Changed printf usage to xil_printf Changed "\n\r" in xil_printf calls
to "\r\n" MH 08/04/17 Added ability to change HDCP capability 3.03 YB 08/14/18
Clubbing Repeater specific code under the 'ENABLE_HDCP_REPEATER' macro. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdcp.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdcp.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdcp.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdcp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp.h This is the main header
file for the Xilinx HDCP abstraction layer. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 MH 05/24/16 First Release 1.01 MH 06/16/17
Removed authentication request flag. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdcp.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdcp.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdcp.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdcp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_edid.c This file
demonstrates application usage for EDID <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 19/02/18 Initial release. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdmi_edid.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdmi_edid.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdmi_edid.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdmi_edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_edid.h This file contains
set of EDID demonstrates different capability <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.00 12/02/18 Initial release. 1.01 EB
05/04/18 Updated EDID </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdmi_edid.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdmi_edid.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdmi_edid.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdmi_edid.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_example.c This file
demonstrates how to use Xilinx HDMI TX Subsystem, HDMI RX Subsystem and Video
PHY Controller drivers. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 25/11/15 Initial release. 1.10 05/02/16 Updated function
RxAuxCallback. 2.00 MG 02/03/15 Added upgraded with HDCP driver and overlay 2.10
MH 06/23/16 Added HDCP repeater support. 2.11 YH 04/08/16 Added two level
validation routines Basic_validation will only check the received VmId
PRBS_validation will check both video & audio contents 2.12 GM 07/10/16 Added
onboard SI5324 Initialization API to enable 125Mhz as NI-DRU reference clock
2.13 YH 03/01/16 Fixed a system hang issue by clearing TxBusy flag when a non-
supportedvideo resolution is set during enable colorbar API 2.14 GM 23/01/17
Replace the Extraction Value of VPhy line rate with, XVphy_GetLineRateHz Rate
API return value. 2.15 ms 04/10/17 Modified filename tag to include the file in
doxygen examples. 2.16 mmo 05/05/17 Replace pre-processed interrupt vector ID
with the pre-processed canonical interrupt vector ID for microblaze processor
2.17 YH 12/06/17 Removed unused PRBS validation related codes Added VPHY error
processing APIs and typedef Placed Si5324 on reset on bonded mode in
StartTxAfterRx Changed printf usage to xil_printf Changed "\n\r" in xil_printf
calls to "\r\n" 2.18 mmo 21/07/17 Remove the i2c_dp159 API Call and
XVphy_Clkout1OBufTdsEnable API Call from the TxStreamCallback API to avoid the
race condition, and replace to be call at the global while loop. MH 26/07/17 Set
TMDS SCDC register after TX HPD toggle event GM 18/08/17 Added SI Initialization
after the SI Reset in StartTxAfterRx API YH 18/08/17 Add HDCP Ready checking
before set down streams GM 28/08/17 Replace XVphy_HdmiInitialize API Call during
Initialization with XVphy_Hdmi_CfgInitialize API Call mmo 04/10/17 Updated
function TxStreamUpCallback to include XhdmiACRCtrl_TMDSClkRatio API Call EB
06/11/17 Updated function RxAudCallback to allow pass-through of audio format
setting 3.00 mmo 29/12/17 Added EDID Parsing Capability EB 16/01/18 Added
InfoFrame capability YH 16/01/18 Added video_bridge overflow interrupt Added
video_bridge unlock interrupt GM 16/01/18 Updated EnableColorBar to skip TX
reconfiguration when the requested TX video resolution is not supported EB
23/01/18 Modified RxStreamUpCallback so that scrambling flag is always enabled
for HDMI 2.0 resolutions and always disabled for HDMI 1.4 resolutions during
pass-through mode EB 26/01/18 Updated function UpdateFrameRate to use the API
XVidC_GetVideoModeIdExtensive MMO 08/02/18 Updated the EnableColorBar,
UpdateFrameRate, UpdateColorDepth, UpdateColorFormat API for clean flow. GM
Added support for ZCU104 SM 28/02/18 Added code to call API for setting App
version to support backward compatibility related issues. 3.01 EB 09/04/18
Updated XV_ConfigTpg and EnableColorBar APIs 18/04/18 Updated
RxBrdgOverflowCallback to remove printing 3.02 mmo 23/04/18 Added checking Sink
Capability whether it's a DVI sink or HDMI sink based on EDID-HDMI VSDB. Fixed
system flow to avoid RX Buffer Overflow during transition. Code Clean-Up on
comments and 80 Characted per line. Improve audio configuration during Pass-
through mode. Disable HDMI RX Video Stream when EnableColorBar API is called.
Added TX Bridge Overflow and TX Bridge Underflow 3.03 YB 08/14/18 Clubbing
Repeater specific code under the 'ENABLE_HDCP_REPEATER' macro. EB 09/21/18 Added
new API ToggleHdmiRxHpd and SetHdmiRxHpd Updated CloneTxEdid API 3.04 EB
03/01/19 Fixed an issue where TX's color space is not up-to-date in pass-through
mode Fixed an issue where SCDC is not cleared when HPD is toggled Fixed an issue
where TX stream doesn't come up when hotplug is performed on HDMI 2.0 resolution
in loopback mode EB 03/08/19 Fixed an issue where loading of default EDID
doesn't toggle HPD mmo 03/08/19 Added "IsStreamUpHDCP" to enable the HDCP
Authentication on the first VSYNC of TX </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/I2S/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdmi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_example.h This file
contains set of definition for the main application <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 12/02/18 Initial release. 3.03
YB 08/14/18 Adding macro 'ENABLE_HDCP_REPEATER' to allow application to
select/deselect the Repeater specific code. EB 09/21/18 Added new API
ToggleHdmiRxHpd </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/I2S/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdmi_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_menu.c This file contains
the Xilinx Menu implementation as used in the HDMI example design. Please see
xhdmi_menu.h for more details. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- ---------- X.X .. DD-MM-YYYY .. 1.0 RHe 10-07-2015 Initial version
1.1 MG 16-07-2015 Expanded menu options 1.2 MG 23-07-2015 Added EDID options 1.3
MG 05-08-2015 Added Audio menu 1.4 MG 03-02-2016 Added HDCP menu 1.5 MH
06-24-2016 Added HDCP repeater support. 1.6 YH 03-01-2017 Remove Video Pattern
from UART menu when it is not enabled in TPG XGUI (CR-961051) Remove
XV_HdmiRxSs_LoadDefaultEdid from UART menu Added 480i and 576i Support in the
UART 1.7 GM 01-02-2017 Change PLL Layout menu access to GTX only in
XHdmi_GtPllLayoutMenu API 1.8 mmo 02-03-2017 Added Support to Set HDMI TX to be
on HDMI or DVI Mode. 1.9 mmo 26-04-2017 Change PLL Layout menu access to GTX
only in XHdmi_DisplayGtPllLayoutMenu API 1.10 YH 08-06-2017 Set default 4K
resolution for GTPE2 to 4KP30 for RGB and YUV444 Disabled deep color settings at
max resolution Changed printf usage to xil_printf Changed "\n\r" in xil_printf
calls to "\r\n" MH 09-08-2017 Added HDCP Debug menu GM 18-08-2017 Clean up the
flow when pressing "p" (Force Passthrough) mmo 18-08-2017 Added Support to
Custom Resolution in the Resolution menu GM 05-09-2017 Changed PLL Layout
routine to toggle HPD to improve stability 1.11 mmo 29-12-2017 Added EDID
Parsing Capability EB 16-01-2018 Added Audio Channel Menu EB 23-01-2018 Reset
the counter tagged to the events logged whenever log is displayed 1.12 EB
09-04-2018 Fixed messages printing issue 3.03 YB 08-14-2018 Updating the Hdcp
Menu to remove Repeater options if 'ENABLE_HDCP_REPEATER' macro is not selected.
3.04 mmo 08-03-2019 Updating the global variable "EdidHdmi20_t" during EDID
parsing through menu. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdmi_menu.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdmi_menu.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/I2S/xhdmi_menu.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdmi_menu.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdmi_menu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_menu.h This is the main
header file for the Xilinx Menu implementation as used in the HDMI example
design. <b>Software Initialization & Configuration</b> <b>Interrupts </b> <b>
Virtual Memory </b> This driver supports Virtual Memory. The RTOS is responsible
for calculating the correct device base address in Virtual Memory space. <b>
Threads </b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver. <b> Asserts
</b> Asserts are used within all Xilinx drivers to enforce constraints on
argument values. Asserts can be turned off on a system-wide basis by defining at
compile time, the NDEBUG identifier. By default, asserts are turned on and it is
recommended that users leave asserts on during development. <b> Building the
driver </b> <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
---------- X.X .. DD-MM-YYYY .. 1.0 RHe 10-07-2015 Initial version 1.1 MG
03-02-2016 Added HDCP support 1.1 YH 27-07-2016 Remove Separate HDCP menu, keep
only HDCP Main Menu 1.2 MH 09-08-2017 Added HDCP Debug Menu mmo 18-08-2017 Added
Support to Custom Resolution in the Resolution menu </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/PassThrough/xhdmi_menu.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RxOnly/xhdmi_menu.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/I2S/xhdmi_menu.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/PassThrough/xhdmi_menu.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/TxOnly/xhdmi_menu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp.c This file contains the
main implementation of the Xilinx HDCP abstraction layer. The HDCP abstraction
layer can support repeater topologies with a single upstream interface and up to
32 downstream interfaces. Both HDCP 1.4 and 2.2 protocols are supported. The
interactions between the repeater upstream and downstream interface are
implemented in the HDCP abstraction layer including: upstream topology
propagation, and downstream stream management propagation. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 MH 05/24/16 First Release
1.10 MG 10/21/16 Updated the Hdcp_Poll function 1.20 MG 10/26/16 Added interval
in Hdcp_Poll function 1.30 MH 06/16/17 Removed authentication request flag. GM
07/12/17 Changed printf usage to xil_printf Changed "\n\r" in xil_printf calls
to "\r\n" MH 08/04/17 Added ability to change HDCP capability 3.03 YB 08/14/18
Clubbing Repeater specific code under the 'ENABLE_HDCP_REPEATER' macro. Initial
release of Repeater ExDes. Updated XHdcp_Authenticate, XHdcp_StreamUpCallback,
XHdcp_AuthenticationRequestCallback, XHdcp_AssembleTopolgy. Updating
UpstreamAuthRequestCount flag in StreamConnect, StreamDisconnect and
AuthenticateCallback flow. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/Repeater/xhdcp.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RepeaterProfessional/xhdcp.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/Repeater/xhdcp.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/RepeaterProfessional/xhdcp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdcp.h This is the main header
file for the Xilinx HDCP abstraction layer. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 MH 05/24/16 First Release 1.01 MH 06/16/17
Removed authentication request flag. 3.03 YB 08/14/18 Initial release of
Repeater ExDes. Added macro 'XHDCP_MAX_DEVICE_CNT_CTS_HDCP14', for maximum
devices supported for HDCP1.4 CTS. Added flag 'UpstreamAuthRequestCount'. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/Repeater/xhdcp.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RepeaterProfessional/xhdcp.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/Repeater/xhdcp.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/RepeaterProfessional/xhdcp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_example.c This file
demonstrates how to use Xilinx HDMI TX Subsystem, HDMI RX Subsystem and Video
PHY Controller drivers. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 25/11/15 Initial release. 1.10 05/02/16 Updated function
RxAuxCallback. 2.00 MG 02/03/15 Added upgraded with HDCP driver and overlay 2.10
MH 06/23/16 Added HDCP repeater support. 2.11 YH 04/08/16 Added two level
validation routines Basic_validation will only check the received VmId
PRBS_validation will check both video & audio contents 2.12 GM 07/10/16 Added
onboard SI5324 Initialization API to enable 125Mhz as NI-DRU reference clock
2.13 YH 03/01/16 Fixed a system hang issue by clearing TxBusy flag when a non-
supportedvideo resolution is set during enable colorbar API 2.14 GM 23/01/17
Replace the Extraction Value of VPhy line rate with, XVphy_GetLineRateHz Rate
API return value. 2.15 ms 04/10/17 Modified filename tag to include the file in
doxygen examples. 2.16 mmo 05/05/17 Replace pre-processed interrupt vector ID
with the pre-processed canonical interrupt vector ID for microblaze processor
2.17 YH 12/06/17 Removed unused PRBS validation related codes Added VPHY error
processing APIs and typedef Placed Si5324 on reset on bonded mode in
StartTxAfterRx Changed printf usage to xil_printf Changed "\n\r" in xil_printf
calls to "\r\n" 2.18 mmo 21/07/17 Remove the i2c_dp159 API Call and
XVphy_Clkout1OBufTdsEnable API Call from the TxStreamCallback API to avoid the
race condition, and replace to be call at the global while loop. MH 26/07/17 Set
TMDS SCDC register after TX HPD toggle event GM 18/08/17 Added SI Initialization
after the SI Reset in StartTxAfterRx API YH 18/08/17 Add HDCP Ready checking
before set down streams GM 28/08/17 Replace XVphy_HdmiInitialize API Call during
Initialization with XVphy_Hdmi_CfgInitialize API Call mmo 04/10/17 Updated
function TxStreamUpCallback to include XhdmiACRCtrl_TMDSClkRatio API Call EB
06/11/17 Updated function RxAudCallback to allow pass-through of audio format
setting 3.00 mmo 29/12/17 Added EDID Parsing Capability EB 16/01/18 Added
InfoFrame capability YH 16/01/18 Added video_bridge overflow interrupt Added
video_bridge unlock interrupt GM 16/01/18 Updated EnableColorBar to skip TX
reconfiguration when the requested TX video resolution is not supported EB
23/01/18 Modified RxStreamUpCallback so that scrambling flag is always enabled
for HDMI 2.0 resolutions and always disabled for HDMI 1.4 resolutions during
pass-through mode EB 26/01/18 Updated function UpdateFrameRate to use the API
XVidC_GetVideoModeIdExtensive MMO 08/02/18 Updated the EnableColorBar,
UpdateFrameRate, UpdateColorDepth, UpdateColorFormat API for clean flow. GM
Added support for ZCU104 SM 28/02/18 Added code to call API for setting App
version to support backward compatibility related issues. 3.01 EB 09/04/18
Updated XV_ConfigTpg and EnableColorBar APIs 18/04/18 Updated
RxBrdgOverflowCallback to remove printing 3.02 mmo 23/04/18 Added checking Sink
Capability whether it's a DVI sink or HDMI sink based on EDID-HDMI VSDB. Fixed
system flow to avoid RX Buffer Overflow during transition. Code Clean-Up on
comments and 80 Characted per line. Improve audio configuration during Pass-
through mode. Disable HDMI RX Video Stream when EnableColorBar API is called.
Added TX Bridge Overflow and TX Bridge Underflow 3.03 YB 08/14/18 Clubbing
Repeater specific code under the 'ENABLE_HDCP_REPEATER' macro. Initial release
of Repeater ExDes. Updated TxToggleCallback. Added check for a valid stream
before calling XHdcp_StreamUpCallback. Updated XHdcp_SetRepeater function to
init to TRUE. Added update to block the colorbar mode from starting when system
is repeater. Update added under the 'ENABLE_REPEATER_COLORBARSTOP' macro and can
be optionally selected to increase performance of Repeater in meeting timing
requirements ; disabled by default. EB 09/21/18 Added new API ToggleHdmiRxHpd
and SetHdmiRxHpd Updated CloneTxEdid API 3.04 EB 03/01/19 Fixed an issue where
TX's color space is not up-to-date in pass-through mode Fixed an issue where
SCDC is not cleared when HPD is toggled Fixed an issue where TX stream doesn't
come up when hotplug is performed on HDMI 2.0 resolution in loopback mode EB
03/08/19 Fixed an issue where loading of default EDID doesn't toggle HPD mmo
03/08/19 Added "IsStreamUpHDCP" to enable the HDCP Authentication on the first
VSYNC of TX </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/Repeater/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RepeaterProfessional/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/Repeater/xhdmi_example.c
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/RepeaterProfessional/xhdmi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_example.h This file
contains set of definition for the main application <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 12/02/18 Initial release. 3.03
YB 08/14/18 Initial release of Repeater ExDes. 3.03 YB 08/14/18 Adding macro
'ENABLE_HDCP_REPEATER' to allow application to select/deselect the Repeater
specific code. EB 09/21/18 Added new API ToggleHdmiRxHpd </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/Repeater/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RepeaterProfessional/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/Repeater/xhdmi_example.h
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/RepeaterProfessional/xhdmi_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirxss.c This is main code
of Xilinx HDMI Receiver Subsystem device driver. Please see xv_hdmirxss.h for
more details of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 10/07/15 Initial release. 1.1 yh 15/01/16 Added 3D
Video support 1.2 yh 20/01/16 Added remapper support 1.3 yh 01/02/16 Added
set_ppc api 1.4 yh 01/02/16 Removed xil_print "Cable (dis)connected" 1.5 yh
01/02/16 Removed xil_printf("Active audio channels...) 1.6 yh 15/02/16 Added
default value to XV_HdmiRxSs_ConfigRemapper 1.7 MG 03/02/16 Added HDCP support
1.8 MG 10/02/16 Moved HDCP 2.2 reset from stream up/down callback to connect
callback 1.9 MH 15/03/16 Added HDCP authenticated callback support 1.10 MH
23/04/16 1. HDCP 1.x driver now uses AXI timer 4.1, so updated to use AXI Timer
config structure to determine timer clock frequency 2. HDCP 1.x driver has fixed
the problem where the reset for the receiver causes the entire DDC peripheral to
get reset. Based on this change the driver has been updated to use
XV_HdmiRxSs_HdcpReset and XV_HdmiRxSs_HdcpReset functions directly. 3. Updated
XV_HdmiRxSs_HdcpEnable and XV_HdmiRxSs_HdcpEnable functions to ensure that HDCP
1.4 and 2.2 are mutually exclusive. This fixes the problem where HDCP 1.4 and
2.2 state machines are running simultaneously. 1.11 MG 13/05/16 Added DDC
peripheral HDCP mode selection to XV_HdmiRxSs_HdcpEnable 1.12 MH 23/06/16 Added
HDCP repeater support. 1.13 YH 18/07/16 1. Replace xil_print with xdbg_printf.
2. Replace MB_Sleep() with usleep() 1.14 YH 25/07/16 Used UINTPTR instead of u32
for BaseAddress XV_HdmiRxSs_CfgInitialize 1.15 MH 26/07/16 Updates for automatic
protocol switching 1.16 MH 05/08/16 Updates to optimize out HDCP when excluded
1.17 YH 17/08/16 Remove sleep in XV_HdmiRxSs_ResetRemapper squash unused
variable compiler warning Added Event Log 1.18 MH 08/10/16 Improve HDCP 1.4
authentication 1.19 MG 31/10/16 Fixed issue with reference clock compensation in
XV_HdmiRxSS_SetStream 1.20 YH 14/11/16 Added API to enable/disable YUV420/Pixel
Drop Mode for video bridge 1.21 YH 14/11/16 Remove Remapper APIs Replace
XV_HdmiRxSs_ConfigRemapper API with XV_HdmiRxSs_ConfigBridgeMode API as remapper
feature is moved to video bridge and controlled by HDMI core 1.22 MMO 03/01/17
Add compiler option(XV_HDMIRXSS_LOG_ENABLE) to enable Log Move global variable
XV_HdmiRx_VSIF VSIF to local XV_HdmiRxSs_RetrieveVSInfoframe API Move HDCP
related API's to hdmirxss_hdcp.c 1.23 MMO 10/02/17 Added Sync Loss and HDMI/DVI
Interrupt Support 1.4 YH 07/07/17 Add new log type
XV_HDMIRXSS_LOG_EVT_SETSTREAM_ERR Report HDMI/DVI mode in HDMI example design
info log 1.41 MMO 21/07/17 CR-979900 (Fix) Removed the HDCP Push Event API Call
when the Aux Callback event happen MH 09/08/17 Added function
XV_HdmiRxSs_HdcpSetCapability 1.42 YH 06/10/17 Added function
XV_HdmiRxSs_GetAudioFormat EB 10/10/17 Updated function XV_HdmiRxSs_ReportAudio
to report audio format 5.00 YH 16/11/17 Added dedicated reset for each clock
domain 16/11/17 Added bridge overflow interrupt EB 16/01/18 Added parsing of
InfoFrames during AuxCallback Changed XV_HdmiRxSs_RetrieveVSInfoframe's input
parameter type Added function XV_HdmiRxSs_GetAviInfoframe, XV_HdmiRxSs_GetGCP,
XV_HdmiRxSs_GetAudioInfoframe, XV_HdmiRxSs_GetVSIF Updated
XV_HdmiRxSs_ConfigBridgeMode so Pixel Pepetition is based on received AVI
InfoFrame SM 28/02/18 Added definition of XV_HdmiRxSS_SetAppVersion() API 5.10
MMO 06/04/18 Updated XV_HdmiRxSs_ToggleHpd and XV_HdmiRxSs_Stop for cleaner HPD
flow during transition from HDMI2.0 to HDMI1.4 YH 13/04/18 Fixed a bug in
XV_HdmiRxSs_BrdgOverflowCallback 5.20 EB 03/08/18 Added function
XV_HdmiRxSs_AudioMute Added TMDS Clock Ratio callback support Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirxss.h This is main
header file of the Xilinx HDMI RX Subsystem driver <b>HDMI RX Subsystem
Overview</b> Video Subsystem is a collection of IP cores bounded together by
software to provide an abstract view of the processing pipe. It hides all the
complexities of programming the underlying cores from end user. <b>Subsystem
Driver Features</b> Video Subsystem supports following features - AXI Stream
Input/Output interface - 1, 2 or 4 pixel-wide video interface - 8/10/12/16 bits
per component - RGB & YCbCr color space - Up to 4k2k 60Hz resolution at both
Input and Output interface - Interlaced input support (1080i 50Hz/60Hz) <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15
Initial release. 1.1 yh 20/01/16 Added remapper support 1.2 yh 01/02/16 Added
set_ppc api 1.3 MG 03/02/16 Added HDCP support 1.4 MH 03/15/16 Added HDCP
connect event. Added HDCP authenticated callback support. 1.5 YH 17/03/16 Remove
xintc.h as it is processor dependent 1.6 MH 23/06/16 Added HDCP repeater
support. 1.7 YH 25/07/16 Used UINTPTR instead of u32 for BaseAddress 1.8 MH
26/07/16 Updates for automatic protocol switching 1.9 MH 05/08/16 Updates to
optimize out HDCP when excluded 1.10 YH 18/08/16 Combine Report function into
one ReportInfo 1.11 YH 14/11/16 Added API to enable/disable YUV420/Pixel Drop
Mode for video bridge 1.15 YH 14/11/16 Remove Remapper APIs as remapper feature
is moved to video bridge and controlled by HDMI core 1.16 MMO 03/01/17 Add
compiler option(XV_HDMIRXSS_LOG_ENABLE) to enable Log Re-order the enumaration
and data structure Move HDCP local API into _hdcp.h ms 03/17/17 Added readme.txt
file in examples folder for doxygen generation. ms 04/10/17 Modified filename
tag in examples to include them in doxygen. 1.4 YH 07/07/17 Add new log type
XV_HDMIRXSS_LOG_EVT_SETSTREAM_ERR MH 09/08/17 Add function
XV_HdmiRxSs_HdcpSetCapability YH 06/10/17 Add function
XV_HdmiRxSs_GetAudioFormat 5.0 YH 16/11/17 Added dedicated reset for each clock
domain 16/11/17 Added bridge overflow interrupt EB 16/01/18 Added InfoFrame data
structure to XV_HdmiRxSs Added XV_HDMIRXSS_LOG_EVT_PIX_REPEAT_ERR log event
Added functions XV_HdmiRxSs_GetAviInfoframe, XV_HdmiRxSs_GetGCP,
XV_HdmiRxSs_GetAudioInfoframe, XV_HdmiRxSs_GetVSIF SM 28/02/18 Added
XV_HdmiRxSS_SetAppVersion API and AppMajVer and AppMinVer version number in
XV_HdmiRxSs structure 5.2 YB 08/14/18 Added dedicated callbacks for HDCP 1.4 and
HDCP 2.2 protocol events. EB 03/08/18 Added function XV_HdmiRxSs_AudioMute Added
TMDS Clock Ratio callback support YB 17/08/18 Marked XV_HDMIRXSS_HDCP_1_PROT_EVT
and XV_HDMIRXSS_HDCP_2_PROT_EVT as deprecated. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirxss_coreinit.c
@addtogroup v_hdmirxss_v4_0 @{ @details HDMI RX Subsystem Sub-Cores
initialization The functions in this file provides an abstraction from the
initialization sequence for included sub-cores. Subsystem is assigned an address
and range on the axi-lite interface. This address space is condensed where-in
each sub-core is at a fixed offset from the subsystem base address. For
processor to be able to access the sub-core this offset needs to be transalted
into a absolute address within the subsystems addressable range <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15
Initial release. 1.1 yh 20/01/16 Added remapper support 1.2 MG 20/01/16 Added
HDCP support 1.3 MH 08/03/16 Added DDC read message not complete event to the
function XV_HdmiRxSs_DdcHdcpCallback. Updated XV_HdmiRxSs_LinkErrorCallback
function to set link error flag. 1.4 MH 23/04/16 Remove XV_HdmiRxSs_Reset from
function XV_HdmiRxSs_SubcoreInitHdmiRx 1.5 MH 15/07/16 Added HDCP repeater
support. 1.6 YH 18/07/16 Replace xil_print with xdbg_printf. 1.7 YH 25/07/16
Used UINTPTR instead of u32 for BaseAddr,HighAddr,Offset AbsAddr 1.8 MH 08/08/16
Updates to optimize out HDCP when excluded. 1.9 YH 14/11/16 Remove Remapper APIs
as remapper feature is moved to video bridge and controlled by HDMI core 1.10
MMO 03/01/17 Remove XV_HdmiRxSs_ComputeSubcoreAbsAddr API, as it handles in the
"_g" TCL generation Move XV_HdmiRx_DdcLoadEdid to xv_hdmirxss.h and call it in
user application Add compiler option(XV_HDMIRXSS_LOG_ENABLE) to enable Log 3.2
MH 04/07/17 Fixed issue to prevent HDCP protocol switching when only one
protocol is in the design. 5.2 YB 13/08/18 Added
XV_HdmiRxSs_DdcHdcp14ProtocolEvtCallback() and
XV_HdmiRxSs_DdcHdcp22ProtocolEvtCallback() functions. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss_coreinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirxss_coreinit.h
@addtogroup v_hdmirxss_v4_0 @{ @details This header file contains the hdmi rx
subsystem sub-cores initialization routines and helper functions. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15
Initial release. 1.1 yh 20/01/16 Added remapper support 1.2 MG 03/02/16 Added
HDCP support 1.3 MH 08/08/16 Updates to optimize out HDCP when excluded. 1.4 YH
14/11/16 Remove Remapper APIs as remapper feature is moved to video bridge and
controlled by HDMI core 1.5 MMO 03/01/16 Remove repetitive inclusion of header
files </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss_coreinit.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirxss_hdcp.c This is main
code of Xilinx HDMI Receiver Subsystem for HDCP Functionality. Please see
xv_hdmirxss.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 MMO 19/12/16 Move HDCP Code from
xv_hdmirxss.c to xv_hdmirxss_hdcp.c 3.2 MH 04/07/17 Fixed issue to prevent HDCP
protocol switching when only one protocol is in the design. MH 09/08/17 Added
function XV_HdmiRxSs_HdcpSetCapability </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss_hdcp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirxss_log.c @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 YH
17/08/16 Initial release. 1.01 MMO 03/01/17 Add compiler
option(XV_HDMIRXSS_LOG_ENABLE) to enable Log 1.4 YH 07/07/17 Add new log type
XV_HDMIRXSS_LOG_EVT_SETSTREAM_ERR 5.0 EB 16/01/18 Added new log
XV_HDMIRXSS_LOG_EVT_PIX_REPEAT_ERR 23/01/18 Minor cleanup MMO 05/02/18 Added new
log XV_HDMIRXSS_LOG_EVT_SYNCEST </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss_log.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmirxss_sinit.c @addtogroup
v_hdmirxss_v4_0 @{ @details This file contains the implementation of the HDMI RX
Subsystem driver's static initialization functionality. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15 Initial release.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss/src/xv_hdmirxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx.c This is the main
file for Xilinx HDMI TX core. Please see xv_hdmitx.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 10/07/15 Initial release. 1.01 yh 15/01/16 Add 3D Support 1.02 MG 09/03/16
Added XV_HdmiTx_SetHdmiMode and XV_HdmiTx_SetDviMode 1.03 YH 25/07/16 Used
UINTPTR instead of u32 for BaseAddress XV_HdmiTx_CfgInitialize 1.04 YH 27/07/16
Remove checking VideoMode<(XVIDC_VM_NUM_SUPPORTED)); 1.05 YH 17/08/16 Add
XV_HdmiTx_SetAxiClkFreq Move XV_HdmiTx_DdcInit to XV_HdmiTx_SetAxiClkFreq squash
unused variable compiler warning 1.06 MG 07/03/17 Updated XV_HdmiTx_Auxsend with
packet ready check 1.07 YH 19/07/17 Added Video Masking Check API 1.08 YH
06/10/17 Added function XV_HdmiTx_SetAudioFormat and function
XV_HdmiTx_GetAudioFormat EB 10/10/17 Updated XV_HdmiTx_Scrambler to always
enable scrambler for HDMI 2.0 resolutions 1.09 MMO 19/12/17 Added
XV_HdmiTx_SetTmdsClk API 2.00 YH 16/01/18 Added dedicated reset for each clock
domain Added bridge unlock interrupt Added PIO_OUT to set GCP_AVMUTE EB 18/01/18
Moved VicTable to Hdmi Common library Updated function XV_HdmiTx_SetTmdsClk and
renamed to XV_HdmiTx_GetTmdsClk Updated function XV_HdmiTx_SetStream Moved
VicTable, XV_HdmiTx_Aux to Hdmi Common library EB 23/01/18 Updated
XV_HdmiTx_SetAudioChannels to fix an issue where setting audio channel value
will unmute the audio regardless of the current status 2.02 MMO 11/08/18 Added
Bridge Overflow and Bridge Underflow (PIO IN) EB 14/08/18 Updated
XV_HdmiTx_CfgInitialize to initialize HPD pulse periods 2.03 EB 28/03/19 Disable
PIO Interrupt for XV_HdmiTx_DdcWrite and XV_HdmiTx_DdcRead APIs to prevent
another DDC transactions from happening in the middle of a DDC transaction
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx.h This is the main
header file for Xilinx HDMI TX core. HDMI TX core is used for transmitting the
incoming video and audio streams. It consists of - Transmitter core -
AXI4-Stream to Video Bridge - Video Timing Controller and - High-bandwidth
Digital Content Protection (HDCP) (Optional). The HDMI TX uses three AXI
interfaces for Video, Audio and Processor: - AXI4-Stream interface for Video,
can be single, dual or quad pixels per clock and supports 8 and 10 bits per
component. - AXI4-Stream interface for Audio, accepts multiple channels
uncompressed and compressed audio data. - AXI4-Lite interface for processor,
controls the transmitter. Please do refer AXI Reference Guide (UG761) for more
information on AXI interfaces. Transmitter core performs following operations: -
Converts video data from the video clock domain into the link clock domain. -
TMDS (Transition Minimized Differential Signaling) encoding. - Merges encoded
video data and packet data into a single HDMI stream. - Optional HDMI stream is
encrypted by an external HDCP module. - Over samples HDMI stream if stream
bandwidth is too low for the transceiver to handle. - Scrambles encrypted/HDMI
stream if data rate is above 3.4 Gbps otherwise bypasses the Scrambler. AXI
Video Bridge converts the incoming video AXI-stream to native video. Video
Timing Controller (VTC) generates the native video timing. <b>Core Features </b>
For a full description of HDMI TX features, please see the hardware
specification. <b>Software Initialization & Configuration</b> The application
needs to do following steps in order for preparing the HDMI TX core to be ready.
- Call XV_HdmiTx_LookupConfig using a device ID to find the core configuration.
- Call XV_HdmiTx_CfgInitialize to initialize the device and the driver instance
associated with it. <b>Interrupts </b> This driver provides interrupt handlers -
XV_HdmiTx_IntrHandler, for handling the interrupts from the HDMI TX core PIO and
DDC peripheral respectively. Application developer needs to register interrupt
handler with the processor, within their examples. Whenever processor calls
registered application's interrupt handler associated with interrupt id,
application's interrupt handler needs to call appropriate peripheral interrupt
handler reading peripheral's Status register. This driver provides
XV_HdmiTx_SetCallback API to register functions with HDMI TX core instance. <b>
Virtual Memory </b> This driver supports Virtual Memory. The RTOS is responsible
for calculating the correct device base address in Virtual Memory space. <b>
Threads </b> This driver is not thread safe. Any needs for threads or thread
mutual exclusion must be satisfied by the layer above this driver. <b> Asserts
</b> Asserts are used within all Xilinx drivers to enforce constraints on
argument values. Asserts can be turned off on a system-wide basis by defining at
compile time, the NDEBUG identifier. By default, asserts are turned on and it is
recommended that users leave asserts on during development. <b> Building the
driver </b> The HDMI TX driver is composed of several source files. This allows
the user to build and link only those parts of the driver that are necessary.
<pre> MODIFICATION HISTORY: s Ver Who Date Changes ----- ------ -------- 1.00
10/07/15 Initial release. 1.1 yh 15/01/16 Add 3D Support 1.2 MG 09/03/16 Added
XV_HdmiTx_SetHdmiMode and XV_HdmiTx_SetDviMode. Removed support for reduced
blanking 1.3 YH 25/07/16 Used UINTPTR instead of u32 for BaseAddress
XV_HdmiTx_Config XV_HdmiTx_CfgInitialize 1.4 YH 17/08/16 Added
XV_HdmiTx_SetAxiClkFreq 1.5 YH 14/11/16 Added XV_HdmiTx_Bridge_yuv420 &
XV_HdmiTx_Bridge_pixel mode macros 1.6 MG 28/03/17 Added XV_HdmiTx_Mask macros
1.7 YH 19/07/17 Added XV_HdmiTx_IsMasked macro 22/08/17 Added
XV_HdmiTx_Audio_LPCM macro Added XV_HdmiTx_Audio_HBR macro 1.8 YH 06/10/17
Replaced XV_HdmiTx_Audio_LPCM and XV_HdmiTx_Audio_HBR macro with API
XV_HdmiTx_SetAudioFormat Added XV_HdmiTx_GetAudioFormat 1.9 EB 24/10/17 Added
enum XV_HdmiTx_AudioFormatType 1.10 MMO 19/12/17 Added XV_HdmiTx_SetTmdsClk API
2.0 EB 16/01/18 Updated function XV_HdmiTx_SetTmdsClk and renamed to
XV_HdmiTx_ConfigTmdsClk Moved Vendor Specific InfoFrame related functions to
HDMI Common library Deprecating XV_HdmiTx_VSIF_GeneratePacket,
XV_HdmiTx_VSIF_DisplayInfo, XV_HdmiTx_VSIF_3DStructToString,
XV_HdmiTx_VSIF_3DSampMethodToString and XV_HdmiTx_VSIF_3DSampPosToString APIs
Moved VicTable, XV_HdmiTx_Aux to Hdmi Common library EB 24/01/18 Added
OverrideHdmi14Scrambler to XV_HdmiTx_Stream 2.2 EB 03/08/18 Marked
XV_HdmiTx_AudioMute and XV_HdmiTx_AudioUnmute as deprecated MMO 11/08/18 Added
Bridge Overflow and Bridge Underflow (PIO IN) </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx_hw.h This header file
contains identifiers and register-level core functions (or macros) that can be
used to access the Xilinx HDMI TX core. For more information about the operation
of this core see the hardware specification and documentation in the higher
level driver xv_hdmitx.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 10/07/15 Initial release. 1.01 YH 25/07/16 Used
UINTPTR instead of u32 for BaseAddress XV_HdmiTx_WriteReg XV_HdmiTx_ReadReg 1.02
YH 14/11/16 Added BRIDGE_YUV420 and BRIDGE_PIXEL mask to PIO Out 1.03 MG
06/03/17 Added XV_HDMITX_AUX_STA_PKT_RDY_MASK 1.04 MMO 03/05/17 Updated the
comments for XV_HdmiTx_ReadReg and XV_HdmiTx_WriteReg 1.1 MG 03/05/17 Introduced
video mask peripheral 1.2 YH 22/08/17 Added XV_HDMITX_AUD_CTRL_AUDFMT_MASK
(Audio Format) 1.3 YH 06/10/17 Added XV_HDMITX_AUD_CTRL_AUDFMT_SHIFT (Audio
Format) 1.4 YH 16/01/18 Added PIO_OUT for dedicated reset for each clock domain
Added PIO_IN to bridge unlock interrupt Added PIO_OUT to set GCP_AVMUTE 1.5 MMO
11/08/18 Added PIO_IN to bridge overflow and underflow interrupt EB 14/08/18
Added XV_HDMITX_HPD_TIMEGRID_OFFSET, XV_HDMITX_TOGGLE_CONF_OFFSET and
XV_HDMITX_CONNECT_CONF_OFFSET </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx_intr.c This file
contains interrupt related functions for Xilinx HDMI TX core. Please see
xv_hdmitx.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 10/07/15 Initial release. 1.1 YH
18/08/16 squash unused variable compiler warning 1.2 YH 16/01/18 Added bridge
unlock interrupt 1.3 MMO 11/08/18 Added bridge overflow and underflow interrupt
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx_selftest.c This file
contains self test function for the HDMI TX core. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 10/07/15 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx_sinit.c This file
contains static initialization method for Xilinx HDMI TX core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 10/07/15
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx_vsif.c Contains
function definitions related to Vendor Specific InfoFrames used in HDMI. Please
see xv_hdmitx_vsif.h for more details of the driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00 yh 15/01/15 Initial release for
3D video support 1.01 YH 19/07/17 Clean up Print Statement line ending to "\r\n"
2.00 EB 23/01/18 This file is deprecated. All the APIs are now moved to HDMI
Common library </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx_vsif.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitx_vsif.h This is the
main header file for Vendor Specific InfoFrames used in HDMI. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 yh 15/01/15 Initial
release for 3D video support 2.00 EB 23/01/18 This file is deprecated. All the
APIs are now moved to HDMI Common library </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmitx/src/xv_hdmitx_vsif.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, andor sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions: The above
copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 gmagnay 08/14/15 Initial version of
subsystem tcl 1.1 MG 03/03/16 Added HDCP 2.2 1.2 YH 30/07/16 No HDCP22_SS sub-
cores included in _g.c generation 1.3 YH 16/11/16 Remove Remapper & axi_gpio 1.4
MMO 03/01/16 Added sub-core base address computation in TCL 1.5 MMO 3/01/17 Fix
the TCL to support multiple instance and sync with XV_HdmiTxSs_Config Data
Structure 1.6 MM0 13/02/17 Fix by adding typecasting for C++ Fix 1.7 MMO
08/02/18 Adding YUV420 Support and Low Resolution (NTSC/PAL) Support capability

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/data/v_hdmitxss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file audiogen_drv.c This file
contains ... <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
---------- X.XX XX YYYY/MM/DD ... 1.00 RHe 2014/12/00 First release 1.1 RHe
2015/07/30 Updated ACR GetNVal to be dependent of the TMDS character rate
instead of the video mode. 1.2 NA 2017/04/28 Made Audio PLL settings into a
table for easy editing. Updated SetSampleRate to actually return an error when
something fails along the way. Updated XhdmiAudGen_SetAudClkParam() to use the
PLL settings table. Updated XhdmiAudGen_AudClkConfig() to not hang the system
when PLL fails to get in lock and return an error in that case. Also added the
fractional parts of the PLL settings. 1.3 RHe 2017/07/31 Updated ACR CTS
generation for HDMI 2.0 formats. 1.4 MMO 2017/09/05 Replace U32 with UINTPTR for
64 Bit Addressing Support </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/I2S/audiogen_drv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_menu.c This file contains
the Xilinx implementation to handle i2s 2 channel as used I2S Audio in in the
HDMI example design. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
---------- X.X .. DD-MM-YYYY .. 1.0 RHe 10-07-2015 Initial version </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/examples/xhdmi_example/I2S/xhdmi_i2s_audio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitxss.c This is main code
of Xilinx HDMI Transmitter Subsystem device driver. Please see xv_hdmitxss.h for
more details of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 10/07/15 Initial release. 1.01 MG 17/12/16 Fixed issue
in function SetAudioChannels Updated function XV_HdmiTxSs_SendAuxInfoframe 1.02
yh 12/01/16 Check vtc existance before configuring it 1.03 yh 15/01/16 Add 3D
Support 1.04 yh 20/01/16 Added remapper support 1.05 yh 01/02/16 Added set_ppc
api 1.06 yh 01/02/16 Removed xil_print "Cable (dis)connected" 1.07 yh 15/02/16
Added default value to XV_HdmiTxSs_ConfigRemapper 1.08 MG 03/02/16 Added HDCP
support 1.09 MG 09/03/16 Added XV_HdmiTxSs_SetHdmiMode and
XV_HdmiTxSs_SetDviMode Removed reduced blanking support 1.10 MH 03/15/16 Moved
HDCP 2.2 reset from stream up/down callback to connect callback 1.11 YH 18/03/16
Add XV_HdmiTxSs_SendGenericAuxInfoframe function 1.12 MH 23/04/16 1. HDCP 1.x
driver now uses AXI timer 4.1, so updated to use AXI Timer config structure to
determine timer clock frequency 2. HDCP 1.x driver has fixed the problem where
the reset for the receiver causes the entire DDC peripheral to get reset. Based
on this change the driver has been updated to use XV_HdmiTxSs_HdcpReset and
XV_HdmiTxSs_HdcpReset functions directly. 3. Updated XV_HdmiTxSs_HdcpEnable and
XV_HdmiTxSs_HdcpEnable functions to ensure that HDCP 1.4 and 2.2 are mutually
exclusive. This fixes the problem where HDCP 1.4 and 2.2 state machines are
running simultaneously. 1.13 MH 23/06/16 Added HDCP repeater support. 1.14 YH
18/07/16 1. Replace xil_print with xdbg_printf. 2. XV_HdmiTx_VSIF VSIF global
variable local to XV_HdmiTxSs_SendVSInfoframe 3. Replace MB_Sleep() with usleep
4. Remove checking VideoMode < XVIDC_VM_NUM_SUPPORTED in XV_HdmiTxSs_SetStream
to support customized video format 1.15 YH 25/07/16 Used UINTPTR instead of u32
for BaseAddress XV_HdmiTxSs_CfgInitialize 1.16 YH 04/08/16 Remove unused
functions XV_HdmiTxSs_GetSubSysStruct 1.17 MH 08/08/16 Updates to optimize out
HDCP when excluded. 1.18 YH 17/08/16 Remove sleep in XV_HdmiTxSs_ResetRemapper
Added Event Log Combine Report function into one ReportInfo 1.19 YH 27/08/16
Remove unused functions XV_HdmiTxSs_SetUserTimerHandler XV_HdmiTxSs_WaitUs 1.20
MH 08/10/16 Update function call sequence in XV_HdmiTxSs_StreamUpCallback 1.1x
mmo 04/11/16 Updated the XV_HdmiTxSs_SetAudioChannels API which currently calls
XV_HdmiTx_SetAudioChannels driver, which sets the Audio Channels accordingly.
This fixed is made during v1.2 (2016.1) 1.21 YH 14/11/16 Added API to
enable/disable YUV420/Pixel Repeat Mode for video bridge 1.22 YH 14/11/16 Remove
Remapper APIs as remapper feature is moved to video bridge and controlled by
HDMI core 1.23 mmo 03/01/17 Move HDCP Related API to xv_hdmitxss_hdcp.c Remove
inclusion of the xenv.h and sleep.h as it not used Replaced "print" with
"xil_printf" Replace Carriage Return (\r) and Line Feed (\n) order,\ where the
Carriage Return + Line Feed order is used. 1.24 mmo 02/03/17 Added
XV_HdmiTxSs_ReadEdidSegment API for Multiple Segment Support and HDMI Compliance
Test Updated the XV_HdmiTxSs_ShowEdid API to have support multiple EDID. 1.25 MH
21/04/17 Updated to set HDMI mode in functions XV_HdmiTxSS_SetHdmiMode and
XV_HdmiTxSS_SetDviMode. 1.40 YH 07/07/17 Fixed issue with VTC register read when
video clock is not present Report HDMI/DVI mode in HDMI example design info log
Added Video Masking APIs 1.41 mmo 02/08/17 Initialize the hdcp1.4 first before
the hdcp1.4 timer as the hdcp1.4 timer requires hdcp1.4 to be initialize MH
09/08/17 Added function XV_HdmiTxSs_HdcpSetCapability 22/08/17 Added function
XV_HdmiTxSs_SetAudioFormat 1.42 YH 06/10/17 Updated function
XV_HdmiTxSs_SetAudioFormat Added function XV_HdmiTxSs_GetAudioFormat EB 17/10/17
Added function XV_HdmiTxSs_ReportAudio Updated function XV_HdmiTxSs_ReportInfo
1.43 MMO 19/12/17 Added XV_HdmiTxSS_SetTMDS API 5.00 EB 16/01/18 Updated
XV_HdmiTxSS_SetTMDS API Updated XV_HdmiTxSs_SetVideoStream API Moved
XV_HdmiTxSs_SendVSInfoframe function to HDMI Common Library Updated function
XV_HdmiTxSs_StreamStart, XV_HdmiTxSs_SendGenericAuxInfoframe Added function
XV_HdmiTxSs_GetAviInfoframe, XV_HdmiTxSs_GetAudioInfoframe, XV_HdmiTxSs_GetVSIF
XV_HdmiTxSs_GetAuxiliary Updated XV_HdmiTxSs_ConfigBridgeMode so Pixel
Pepetition AVI InfoFrame is sent out Deprecating XV_HdmiTxSs_SendAviInfoframe
and XV_HdmiTxSs_SendGeneralControlPacket APIs YH 16/01/18 Added dedicated reset
for each clock domain Added bridge unlock interrupt Added PIO_OUT to set
GCP_AVMUTE EB 23/01/18 Added function
XV_HdmiTxSs_SetVideoStreamHdmi14ScramblingOverrideFlag 25/01/18 Added function
XV_HdmiTxSs_SetScrambler 01/02/18 Updated function XV_HdmiTxSs_VtcSetup and
changed the input parameters to it to enable logging of unsupported video timing
by VTC SM 28/02/18 Added definition of XV_HdmiTxSS_SetAppVersion() API 5.20 EB
03/08/18 Updated XV_HdmiTxSS_MaskSetRed, XV_HdmiTxSS_MaskSetGreen,
XV_HdmiTxSS_MaskSetBlue API Replaced XV_HdmiTx_AudioMute API call with
XV_HdmiTx_AudioDisable Replaced XV_HdmiTx_AudioUnmute API call with
XV_HdmiTx_AudioEnable Replaced XV_HdmiTx_AudioUnmute API call with MMO 11/08/18
Added Bridge Overflow and Bridge Underflow Interrupt </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitxss.h This is main
header file of the Xilinx HDMI TX Subsystem driver <b>HDMI Transmitter Subsystem
Overview</b> HDMI TX Subsystem is a collection of IP cores bounded together by
software to provide an abstract view of the processing pipe. It hides all the
complexities of programming the underlying cores from end user. <b>Subsystem
Driver Features</b> HDMI Subsystem supports following features - AXI Stream
Input/Output interface - 1, 2 or 4 pixel-wide video interface - 8/10/12/16 bits
per component - RGB & YCbCr color space - Up to 4k2k 60Hz resolution at both
Input and Output interface - Interlaced input support (1080i 50Hz/60Hz) <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15
Initial release. 1.1 yh 15/01/16 Add 3D Support 1.2 yh 20/01/16 Added remapper
support 1.3 yh 01/02/16 Added set_ppc api 1.4 MG 03/02/16 Added HDCP support 1.5
MG 09/03/16 Removed reduced blanking support and added XV_HdmiTxSS_SetHdmiMode
and XV_HdmiTxSS_SetDviMode 1.6 MH 03/15/16 Added HDCP connect event 1.7 YH
17/03/16 Remove xintc.h as it is processor dependent 1.8 YH 18/03/16 Add
XV_HdmiTxSs_SendGenericAuxInfoframe function 1.9 MH 23/06/16 Added HDCP repeater
support. 1.10 YH 25/07/16 Used UINTPTR instead of u32 for BaseAddress 1.11 MH
08/08/16 Updates to optimize out HDCP when excluded. 1.12 YH 18/08/16 Combine
Report function into one ReportInfo Add Event Log 1.13 YH 27/08/16 Remove unused
function XV_HdmiTxSs_SetUserTimerHandler 1.14 YH 14/11/16 Added API to
enable/disable YUV420/Pixel Repeat Mode for video bridge 1.15 YH 14/11/16 Remove
Remapper APIs as remapper feature is moved to video bridge and controlled by
HDMI core 1.16 mmo 03/01/17 Add compiler option(XV_HDMITXSS_LOG_ENABLE) to
enable Log Re-order the enumation and data structure 1.17 mmo 02/03/17 Added
XV_HdmiTxSs_ReadEdidSegment API for Multiple Segment Support and HDMI Compliance
Test 4.0 YH 19/07/17 Added Video Masking APIs MH 09/08/17 Added function
XV_HdmiTxSs_HdcpSetCapability 22/08/17 Added function XV_HdmiTxSs_SetAudioFormat
EB 10/10/17 Added function XV_HdmiTxSs_GetAudioFormat 5.0 YH 16/01/18 Added
dedicated reset for each clock domain Added bridge unlock interrupt Added
PIO_OUT to set GCP_AVMUTE EB 17/01/18 Added InfoFrame data structure to
XV_HdmiTxSs Added XV_HDMITXSS_LOG_EVT_PIX_REPEAT_ERR log event Added functions
XV_HdmiTxSs_GetAuxiliary, XV_HdmiTxSs_GetAviInfoframe,
XV_HdmiTxSs_GetAudioInfoframe, XV_HdmiTxSs_GetVSIF Updated the return type of
the function XV_HdmiTxSs_SendGenericAuxInfoframe EB 23/01/18 Added function
XV_HdmiTxSs_SetVideoStreamHdmi14ScramblingOverrideFlag 25/01/18 Added function
XV_HdmiTxSs_SetScrambler mmo 08/02/18 Added LowResolutionSupp & YUV420Supp in
the XV_HdmiTxSs_Config SM 28/02/18 Added XV_HdmiTxSS_SetAppVersion API and
AppMajVer and AppMinVer version number in XV_HdmiTxSs structure MMO 11/08/18
Added Bridge Overflow and Bridge Underflow Interrupt </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitxss_coreinit.c
@addtogroup v_hdmitxss_v4_0 @{ @details HDMI TX Subsystem Sub-Cores
initialization The functions in this file provides an abstraction from the
initialization sequence for included sub-cores. Subsystem is assigned an address
and range on the axi-lite interface. This address space is condensed where-in
each sub-core is at a fixed offset from the subsystem base address. For
processor to be able to access the sub-core this offset needs to be transalted
into a absolute address within the subsystems addressable range <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15
Initial release. 1.1 yh 20/01/16 Added remapper support 1.2 MG 03/02/16 Added
HDCP support 1.3 MH 23/04/16 VTC driver has been updated to avoid processor
exceptions. Workarounds have been removed. 1.4 MH 23/06/16 Added HDCP repeater
support. 1.5 YH 18/07/16 Replace xil_printf with xdbg_printf 1.6 YH 25/07/16
Used UINTPTR instead of u32 for BaseAddr,HighAddr,Offset AbsAddr 1.7 MH 08/08/16
Updates to optimize out HDCP when excluded. 1.8 YH 17/08/16 Added Event Log 1.9
YH 14/11/16 Remove Remapper APIs as remapper feature is moved to video bridge
and controlled by HDMI core 1.10 MMO 03/01/17 Remove
XV_HdmiTxSs_ComputeSubcoreAbsAddr API, as it handles in the "_g" TCL generation
Re-align coding style to ensure, 80 characters per row 3.2 MH 04/24/17 Set
default HDMI mode in XV_HdmiTxSs_SubcoreInitHdmiTx 3.3 MH 07/17/17 Set HDCP 2.2
polling value to 10 ms. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss_coreinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitxss_coreinit.h
@addtogroup v_hdmitxss_v4_0 @{ @details This header file contains the hdmi tx
subsystem sub-cores initialization routines and helper functions. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15
Initial release. 1.1 yh 20/01/16 Added remapper support 1.2 MG 03/02/16 Added
HDCP support 1.3 MH 08/08/16 Updates to optimize out HDCP when excluded. 1.4 YH
14/11/16 Remove Remapper APIs as remapper feature is moved to video bridge and
controlled by HDMI core 1.5 MMO 03/01/16 Remove repetitive inclusion of header
files </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss_coreinit.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitxss_hdcp.c This is main
code of Xilinx HDMI Transmitter Subsystem device driver. Please see
xv_hdmitxss.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 MMO 19/12/16 Move HDCP Code from
xv_hdmitxss.c to xv_hdmitxss_hdcp.c 3.20 MH 04/12/17 Updated function
XV_HdmiTxSs_IsSinkHdcp14Capable and XV_HdmiTxSs_IsSinkHdcp22Capable. 08/09/17
Added function XV_HdmiTxSs_HdcpSetCapability </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss_hdcp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitxss_log.c
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 YH 17/08/16 Initial release. 1.01 MMO 03/01/17 Add compiler
option(XV_HDMITXSS_LOG_ENABLE) to enable Log 5.0 EB 16/01/18 Added new log
XV_HDMITXSS_LOG_EVT_PIX_REPEAT_ERR 23/01/18 Minor cleanup </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss_log.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hdmitxss_sinit.c @addtogroup
v_hdmitxss_v4_0 @{ @details This file contains the implementation of the HDMI TX
Subsystem driver's static initialization functionality. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 10/07/15 Initial release.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmitxss/src/xv_hdmitxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 rco 07/21/15 Initial version of vprocss
hscaler subcore tcl 2.0 dmc 12/17/15 Include new arg ENABLE_422 3.0 mpe 04/28/16
Include new arg ENABLE_420, and ENABLE_CSC

FILES:
XilinxProcessorIPLib/drivers/v_hscaler/data/v_hscaler.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hscaler_coeff.c @addtogroup
v_hscaler_v3_1 @{ @details This file provides the default fixed coefficient sets
for supported taps <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 rco 07/31/15 Initial Release 3.1 rco 02/09/17 Fix c++ compilation
warnings </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hscaler/src/xv_hscaler_coeff.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hscaler_l2.c @addtogroup
v_hscaler_v3_1 @{ @details The Horizontal Scaler Layer-2 Driver. The functions
in this file provides an abstraction from the register peek/poke methodology by
implementing most common use-case provided by the sub-core. See xv_hscaler_l2.h
for a detailed description of the layer-2 driver <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 rco 07/21/15 Initial Release 2.00 rco
11/05/15 Integrate layer-1 with layer-2 dmc 12/17/15 Updated the
XV_HScalerDbgReportStatus routine 3.0 mpe 04/28/16 Added optional color format
conversion handling 3.1 rco 11/01/16 Fixed bug in config validation API, wherein
hi/lo check should be made only if input is not RGB rco 02/09/17 Fix c++
compilation warnings jsr 09/07/18 Fix for 64-bit driver support </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/v_hscaler/src/xv_hscaler_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_hscaler_l2.h @addtogroup
v_hscaler_v3_1 @{ @details This header file contains layer 2 API's of the
horizontal scaler sub-core driver.The functions contained herein provides a high
level implementation of features provided by the IP, abstracting away the
register level details from the user <b>H Scaler IP Features </b> This H-Scaler
IP supports following features - 3 Channel Scaler with RGB, YUV444 and optional
YUV422, and YUV420 support - Scale horizontally to 4K line at 60Hz - up to
16bits color depth - 1, 2 or 4 pixel per clock processing <b>Dependency</b> This
driver makes use of the video enumerations and data types defined in the Xilinx
Video Common Driver (video_common_vX.x) and as such the common driver must be
included as dependency to compile this driver <b>Initialization &
Configuration</b> The device driver enables higher layer software (e.g., an
application) to communicate to the hscaler core. Before using the layer-2 API's
user must initialize the core by calling Layer-1 API XV_hscaler_Initialize().
This function will look for a configuration structure for the device and
initialize it to defined HW settings. After initialization Layer-2 API's can be
used to configure the core. It is recommended user always make use of Layer-2
API to interact with this core. Advanced users always have the capability to
directly interact with the IP core using Layer-1 API's that perform low level
register peek/poke. <b> Interrupts </b> This driver does not have any interrupts
<b> Virtual Memory </b> This driver supports Virtual Memory. The RTOS is
responsible for calculating the correct device base address in Virtual Memory
space. <b> Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver.
<b>Limitations</b> <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 rco 07/21/15 Initial Release 2.00 rco 11/05/15 Integrate layer-1
with layer-2 dmc 12/17/15 Add macro to query the Is422Enabled flag that was
added to the XV_hscaler_Config structure 3.0 mpe 04/28/16 Added optional color
format conversion handling </pre>

FILES:
XilinxProcessorIPLib/drivers/v_hscaler/src/xv_hscaler_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_letterbox_l2.c @addtogroup
v_letterbox_v2_1 @{ @details The Letterbox Layer-2 Driver. The functions in this
file provides an abstraction from the register peek/poke methodology by
implementing most common use-case provided by the sub-core. See
xv_letterbox_l2.h for a detailed description of the layer-2 driver <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release 2.00 rco 11/05/15 Integrate layer-1 with layer-2 </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/v_letterbox/src/xv_letterbox_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_letterbox_l2.h @addtogroup
v_letterbox_v2_1 @{ @details This header file contains layer 2 API's of the
letter box sub-core driver. The functions contained herein provides a high level
implementation of features provided by the IP, abstracting away the register
level details from the user <b>Letter Box IP Features </b> This Letterbox IP
supports following features - Apply black bars (horizontal or vertical) on input
stream - Programmable background colors - up to 16bits color depth - 1, 2 or 4
pixel per clock processing - Input stream up to 4k2k 60Hz <b>Dependency</b> This
driver makes use of the video enumerations and data types defined in the Xilinx
Video Common Driver (video_common_vX.x) and as such the common driver must be
included as dependency to compile this driver <b>Initialization &
Configuration</b> The device driver enables higher layer software (e.g., an
application) to communicate to the lbox core. Before using the layer-2 API's
user must initialize the core by calling Layer-1 API XV_letterbox_Initialize().
This function will look for a configuration structure for the device and
initialize it to defined HW settings. After initialization Layer-2 API's can be
used to configure the core. It is recommended user always make use of Layer-2
API to interact with this core. Advanced users always have the capability to
directly interact with the IP core using Layer-1 API's that perform low level
register peek/poke. <b> Interrupts </b> This driver does not have any interrupts
<b> Virtual Memory </b> This driver supports Virtual Memory. The RTOS is
responsible for calculating the correct device base address in Virtual Memory
space. <b> Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release 2.00 rco 11/05/15 Integrate layer-1 with layer-2 </pre>

FILES:
XilinxProcessorIPLib/drivers/v_letterbox/src/xv_letterbox_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file main.c This file demonstrates
the example usage of Mixer IP available in catalogue Please refer v_mix example
design guide for details on HW setup <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 rco 11/24/15 Initial Release 02/05/16 Add Logo
test 03/08/16 Add configuration table for all layers, replace delay with polling
with time out 03/14/16 Fix bug startx not multiple of pixels/clk for window move
08/05/16 Add Logo Pixel Alpha test 2.00 vyc 10/04/17 Add second buffer pointer
for semi-planar formats 2.10 vyc 04/04/18 Add support for streaming layers using
Frame Buffer Read for streaming input Add support for ZCU102, ZCU104, ZCU106
4.00 vyc 04/04/18 Add support for streaming layers using Frame Buffer 5.00 pv
19/04/18 Added flushing feature support in driver. flush bit should be set and
held (until reset) by software to flush pending transactions.IP is expecting a
hard reset, when flushing is done.(There is a flush status bit and is asserted
when the flush is done). </pre>

FILES:
XilinxProcessorIPLib/drivers/v_mix/examples/src/xv_mix_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_mix_l2.c @addtogroup
v_mix_v3_0 @{ Mixer Layer-2 Driver. The functions in this file provides an
abstraction from the register peek/poke methodology by implementing most common
use-case provided by the sub-core. See xv_mix_l2.h for a detailed description of
the layer-2 driver <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 rco 10/29/15 Initial Release 02/10/16 Updated to support IP
changes 02/25/16 Replace GetColorFromat function with a macro 03/08/16 Replace
GetColorFromat macro with function and added master layer video format 03/09/16
Removed stream layer error check from SetWindow API 03/18/16 Window coordinates
can start from 0,0 2.00 rco 07/21/16 Used UINTPTR instead of u32 for Baseaddress
08/03/16 Add Logo Pixel Alpha support 08/16/16 Add check for stream and logo
layer minimum width and height 2.10 rco 11/15/16 Add a check for logo layer
enable before loading logo pixel alpha. IP confguration can have logo feature
disabled but logo pixel alpha enabled 01/26/16 Bug fix - Read power on default
video stream properties from IP configuration 02/09/17 Fix c++ compilation
warnings 3.00 vyc 10/04/17 Add second buffer pointer for semi-planar formats
4.00 vyc 04/04/18 Add 8th overlayer Move logo layer enable fromb bit 8 to bit 15
5.00 pv 11/10/18 Added flushing feature support in driver. flush bit should be
set and held (until reset) by software to flush pending transactions.IP is
expecting a hard reset, when flushing is done.(There is a flush status bit and
is asserted when the flush is done). </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_mix/src/xv_mix_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_mix_l2.h @addtogroup
v_mix_v3_0 @{ @details This header file contains layer 2 API's of the mixer core
driver. The functions contained herein provides a high level implementation of
features provided by the IP, abstracting away the register level details from
the user <b>Mixer IP Features </b> The Mixer IP supports following features -
AXI4-S Master Layer - Up to 8 optional layers (user configurable) - Each layer
can be configured as Streaming or Memory (build time) - Color format for each
layer is set at build time - 1 Logo Layer (optional) - Logo Layer Color Key
feature (optional) - Alpha Level (8 bit) per layer (optional) - Scale (1x, 2x,
4x) capability per layer (optional) <b>Dependency</b> This driver makes use of
the video enumerations and data types defined in the Xilinx Video Common Driver
(video_common_vX.x) and as such the common driver must be included as dependency
to compile this driver <b>Initialization & Configuration</b> The device driver
enables higher layer software (e.g., an application) to communicate with the
mixer core. Driver is built with layered architecture - Layer 1 provides API's
to peek/poke registers at HW level. - Layer 2 provides API's that abstract sub-
core functionality, providing an easy to use feature interface Before using the
layer-2 API's user must initialize the core by calling API XVMix_Initialize().
This function will look for a configuration structure for the device and
initialize it to defined HW settings. It is recommended user always make use of
Layer-2 API to interact with this core. Advanced users always have the
capability to directly interact with the IP core using Layer-1 API's that
perform low level register peek/poke. <b>Pre-Requisite's</b> If optional layers
are included in the IP then - Application must set the memory address for each
layer using provided API Address must be aligned to memory width. This can be
computed with following equation Align 2 PPC 4 Bytes (where PPC is the
Pixels/Clock selected in IP configuration) - When setting up layer window the
Stride must be provided in Bytes and must be aligned to respective color space
of the layer. This can be computed with following equation StrideInBytes
(Window_Width (YUV422 ? 2 : 4)) <b> Interrupts </b> Driver is configured to
operate both in polling as well as interrupt mode. - To use interrupt based
processing, application must set up the system's interrupt controller and
connect the XVMix_InterruptHandler function to service interrupts. Next
interrupts must be enabled using the provided API. When an interrupt occurs, ISR
will confirm if frame processing is is done. If call back is registered such
function will be called and application can apply new setting updates here.
Subsequently next frame processing will be triggered with new settings. - To use
polling method disable interrupts using the provided API. Doing so will
configure the IP to keep processing frames without sw intervention. - Polling
mode is the default configuration set during driver initialization <b> Virtual
Memory </b> This driver supports Virtual Memory. The RTOS is responsible for
calculating the correct device base address in Virtual Memory space. <b> Threads
</b> This driver is not thread safe. Any needs for threads or thread mutual
exclusion must be satisfied by the layer above this driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 10/29/15 Initial
Release 12/14/15 Added interrupt handler 02/12/16 Added Stride and memory
Alignement requirements 02/25/16 Replace GetColorFromat function with a macro
03/08/16 Replace GetColorFromat macro with function and added master layer video
format 2.00 rco 07/21/16 Used UINTPTR instead of u32 for Baseaddress 08/03/16
Add Logo Pixel Alpha support 3.00 vyc 10/04/17 Add second buffer pointer for
semi-planar formats 4.00 vyc 04/04/18 Add 8th overlayer Move logo layer enable
from bit 8 to bit 15 </pre>

FILES:
XilinxProcessorIPLib/drivers/v_mix/src/xv_mix_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_mix_l2_intr.c @addtogroup
v_mix_v3_0 @{ The functions in this file provides interrupt handler and
associated functions that are consumed by layer-2 <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 rco 12/14/15 Initial Release
02/12/16 Move user call back before frame start trigger </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_mix/src/xv_mix_l2_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_multi_scaler_coeff.c
@addtogroup v_multiscaler_v1_0 @{ @details This file provides the default fixed
coefficient sets for supported taps

FILES:
XilinxProcessorIPLib/drivers/v_multi_scaler/src/xv_multi_scaler_coeff.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xv_multi_scaler_intr.c @addtogroup v_multi_scaler_v1_0 @{ The functions in this
file provides interrupt handler and associated functions that are consumed by
layer-2 / Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_multi_scaler/src/xv_multi_scaler_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_multi_scaler_l2.c
@addtogroup v_multi_scaler_v1_0 @{ The Multi Scaler Layer-2 Driver. The
functions in this file provides an abstraction from the register peek/poke
methodology by implementing most common use-case provided by the core. See
xv_multi_scaler_l2.h for a detailed description of the layer-2 driver Include
Files /

FILES:
XilinxProcessorIPLib/drivers/v_multi_scaler/src/xv_multi_scaler_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_multi_scaler_l2.h
@addtogroup v_multiscaler_v1_0 @{ This header file contains layer 2 API's of the
multi scaler core driver.The functions contained herein provides a high level
implementation of features provided by the IP, abstracting away the register
level details from the user <b> Interrupts </b> The driver does the interrupt
handling, and dispatch to the user application through callback functions that
user has registered. If there are no registered callback functions, then a stub
callback function is called. <b> Virtual Memory </b> This driver supports
Virtual Memory. The RTOS is responsible for calculating the correct device base
address in Virtual Memory space. <b> Threads </b> This driver is not thread
safe. Any needs for threads or thread mutual exclusion must be satisfied by the
layer above this driver. <b>Limitations</b>

FILES:
XilinxProcessorIPLib/drivers/v_multi_scaler/src/xv_multi_scaler_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / scd_memory_mode_ex.c: scenechange
IP in memory mode test application. This application configures SceneChange IP
to caluclate SAD values between consecutive streams. The driver accepts the
threshold values per stream and calls the registered callback with SAD value and
stream id. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00 pv 10/10/18 Initial Release Added flushing feature support for the driver.
it supports only for memory based scenechange IP. flush bit should be set and
held (until reset) by software to flush pending transactions.IP is expecting a
hard reset, when flushing is done.(There is a flush status bit and is asserted
when the flush is done). <pre> /

FILES:
XilinxProcessorIPLib/drivers/v_scenechange/examples/src/xv_scenechange_memory_mode_ex.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / scd_stream_mode_ex.c: scenechange
IP in stream mode test application. This application configures SceneChange IP
to caluclate SAD values between consecutive streams. The driver accepts the
threshold values per stream and calls the registered callback with SAD value and
stream id. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00 pv 10/10/18 Initial Release Added flushing feature support for the driver.
it supports only for memory based scenechange IP. flush bit should be set and
held (until reset) by software to flush pending transactions.IP is expecting a
hard reset, when flushing is done.(There is a flush status bit and is asserted
when the flush is done). <pre> /

FILES:
XilinxProcessorIPLib/drivers/v_scenechange/examples/src/xv_scenechange_stream_mode_ex.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xv_scenechange_intr.c
@addtogroup v_scenechange_v1_0 @{ The functions in this file provides interrupt
handler and associated functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 praveenv 13/09/18 Initial Release </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_scenechange/src/xv_scenechange_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_scenechange_l2.c @addtogroup
v_scenechange_v1_0 @{ The SceneChange Layer-2 Driver. The functions in this file
provides an abstraction from the register peek/poke methodology by implementing
most common use-case provided by the core. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 pv 10/10/18 Initial Release. Added
flushing feature support for the driver. it supports only for memory based
scenechange IP. flush bit should be set and held (until reset) by software to
flush pending transactions.IP is expecting a hard reset, when flushing is
done.(There is a flush status bit and is asserted when the flush is done). <pre>
/

FILES:
XilinxProcessorIPLib/drivers/v_scenechange/src/xv_scenechange_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History ver who Date
Changes ----- ---- -------- 1.1 jsr 07/17/17 Created 1.2 jsr 02/28/18 YUV420
support added 1.3 jsr 07/03/18 corrected XVIDC_VM_720x480_60_I as
XVIDC_VM_720x486_60_I vve 10/03/18 Add support for ST352 in C-Stream

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/data/v_sdirx.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirx_example_selftest.c
@addtogroup v_sdirx_v1_0 @{ This file contains a design example using the
XV_SdiRx driver. It performs a self test on the SDI Rx driver that will test its
sub-cores self test functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
--- --- -------- 1.0 jsr 07/17/17 Initial release Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/examples/xv_sdirx_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirx.c This is the main
file for Xilinx SDI RX core. Please see xv_sdirx.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 jsr 07/17/17 Initial release. vve 10/03/18 Add support for ST352 in C-Stream
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/src/xv_sdirx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirx.h <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 jsr 07/17/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/src/xv_sdirx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirx_hw.h This header file
contains identifiers and register-level core functions (or macros) that can be
used to access the Xilinx SDI RX core. For more information about the operation
of this core see the hardware specification and documentation in the higher
level driver xv_sdirx.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 jsr 07/17/17 Initial release. vve 10/03/18 Add support
for ST352 in C-Stream </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/src/xv_sdirx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirx_intr.c This file
contains interrupt related functions for Xilinx SDI RX core. Please see
xv_sdirx.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.0 jsr 07/17/17 Initial release. 1.3 jsr
07/03/18 corrected XVIDC_VM_720x480_60_I as XVIDC_VM_720x486_60_I jsr 10/05/18
Moved 3GB specific video modes timing parameters from video common library to
SDI common driver </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/src/xv_sdirx_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirx_selftest.c @addtogroup
xv_sdirx_v1_1 @{ Contains diagnostic/self-test functions for the SDI Rx
Controller core. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
-------- 1.0 jsr 07/17/17 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/src/xv_sdirx_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirx_sinit.c This file
contains static initialization method for Xilinx SDI RX core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 jsr 07/17/17 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirx/src/xv_sdirx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History ver who Date
Changes ----- ---- -------- 1.1 jsr 07/17/17 Created 2.0 kar 01/18/18 Second
Release

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/data/v_sdirxss.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History ver who Date
Changes ----- ---- -------- 1.1 jsr 07/17/17 Created 2.0 kar 01/25/18 Second
release

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/data/v_sdirxss.tcl
XilinxProcessorIPLib/drivers/v_sditxss/data/v_sditxss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss_selftest_example.c
@addtogroup xv_sdirxss_v1_0 @{ This file contains a design example using the
XV_SdiRxSs driver. It performs a self test on the SDI Rx Subsystem that will
test its sub-cores self test functions. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes --- --- -------- 1.0 jsr 07/17/17 Initial release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xv_sdirxss_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file main.c This file demonstrates
the SDI Tx to SDI Tx loopback design for KCU116 board. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- ---------- 1.0 jsr 03/07/2018 Initial
version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_ctlr.c FMC
configuration file <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_ctlr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_ctlr.h FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_ctlr.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_gpio.c FMC
configuration file <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_gpio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_gpio.h FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_gpio.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_iic.c FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_iic.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_iic.h FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design board. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----
---- ---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_iic.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_init_table.c FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_init_table.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_init_table.h FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_init_table.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_spi.c FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_spi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file fzetta_fmc_spi.h FMC
configuration file This file configures the FMC card for KCU116 SDI Tx to SDI Rx
loopback design <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 jsr 03/07/2018 Initial version </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/kcu116_xuhdsdi_example/fzetta_fmc/fzetta_fmc_spi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si5324drv.c This file
contains low-level driver functions for controlling the SiliconLabs Si5324 clock
generator as mounted on the ZCU106 demo board. The user should refer to the
hardware device specification for more details of the device operation. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- ---------- 1.00 hf
2014/10/10 First release 1.10 MG 2016/07/05 Updated LOCKT register 1.11 YH
2016/09/14 Add option to enable fast switching </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/si5324drv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si5324drv.h This file
contains definitions for low-level driver functions for controlling the
SiliconLabs Si5324 clock generator as mounted on the ZCU106 demo board. The user
should refer to the hardware device specification for more details of the device
operation. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- ----------
1.00 hf 2014/10/10 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/si5324drv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_menu.c This file
contains the Xilinx Menu implementation as used in the SDI example design.
Please see xsdi_menu.h for more details. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- ---------- 1.0 PG 05/09/2017 Initial version </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/xsdi_menu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_menu.h This is the main
header file for the Xilinx Menu implementation as used in the SDI example
design. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---- ----------
1.0 PG 05/09/2017 Initial version </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/xsdi_menu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_example.c This file
demonstrates how to use Xilinx SDI Subsystem for passthrough mode on ZCU106
board. It takes SDI data input through SDI Rx Subsystem and passes the same data
as SDI Data out through SDI Tx Subsystem. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- ---------- 1.0 PG 05/09/2017 Initial version </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_example/xuhdsdi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/platform.c
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/platform.h
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/platform_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si5324drv.c This
file contains low-level driver functions for controlling the SiliconLabs Si5324
clock generator as mounted on the ZCU106 demo board. The user should refer to
the hardware device specification for more details of the device operation.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- ---------- 1.00 hf
2014/10/10 First release 1.10 MG 2016/07/05 Updated LOCKT register 1.11 YH
2016/09/14 Add option to enable fast switching </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/si5324drv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si5324drv.h This
file contains definitions for low-level driver functions for controlling the
SiliconLabs Si5324 clock generator as mounted on the ZCU106 demo board. The user
should refer to the hardware device specification for more details of the device
operation. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- ----------
1.00 hf 2014/10/10 First release </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/si5324drv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsdi_example.c This
file demonstrates how to use Xilinx SDI Rx Subsystem for standalone. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 PG
08/11/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/xsdi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_menu.c This
file contains the Xilinx Menu implementation as used in the SDI example design.
Please see xsdi_menu.h for more details. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- ---------- 1.0 PG 05/09/2017 Initial version </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/xsdi_menu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_menu.h This
is the main header file for the Xilinx Menu implementation as used in the SDI
example design. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ----
---------- 1.0 PG 05/09/2017 Initial version </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/examples/xuhdsdi_rx_example/xsdi_menu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss.c This is the main
file for Xilinx SDI RX core. Please see xv_ddirxss.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 jsr 07/17/17 Initial release. 2.00 kar 01/25/18 Second release. </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss.h This is main
header file of the Xilinx SDI RX Subsystem driver <b>SDI RX Subsystem
Overview</b> Video Subsystem is a collection of IP cores bounded together by
software to provide an abstract view of the processing pipe. It hides all the
complexities of programming the underlying cores from end user. <b>Subsystem
Driver Features</b> Video Subsystem supports following features - AXI Stream
Input/Output interface - 2 pixel-wide video interface - 10 bits per component -
YCbCr 4:2:2 color space - Up to 4k2k 60Hz resolution (12G) at both Input and
Output interface - Interlaced input support (1080i 50Hz/60Hz) <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 jsr 07/17/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss_coreinit.c
@addtogroup v_sdirxss_v1_1 @{ @details SDI RX Subsystem Sub-Cores initialization
The functions in this file provides an abstraction from the initialization
sequence for included sub-cores. Subsystem is assigned an address and range on
the axi-lite interface. This address space is condensed where-in each sub-core
is at a fixed offset from the subsystem base address. For processor to be able
to access the sub-core this offset needs to be transalted into a absolute
address within the subsystems addressable range <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 jsr 07/17/17 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss_coreinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss_coreinit.h
@addtogroup v_sdirxss_v1_1 @{ This header file contains the sdi rx subsystem
sub-cores initialization routines and helper functions. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 jsr 07/17/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss_coreinit.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss_log.c @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 jsr
07/17/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss_log.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss_selftest.c
@addtogroup xv_sdirxss_v1_1 @{ This file contains self test function for the SDI
Rx Subsystem <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------
1.0 jsr 07/17/17 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sdirxss_sinit.c This file
contains static initialization method for Xilinx SDI RX core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 jsr 07/17/17 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sdirxss/src/xv_sdirxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History ver who Date
Changes ----- ---- -------- 1.1 jsr 07/17/17 Created 1.2 jsr 02/28/18 YUV420
support added 2.0 vve 10/03/18 Add support for ST352 in C Stream

FILES:
XilinxProcessorIPLib/drivers/v_sditx/data/v_sditx.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditx_example_selftest.c
@addtogroup v_sditx_v1_0 @{ This file contains a design example using the
XV_SdiTx driver. It performs a self test on the SDI Tx driver that will test its
sub-cores self test functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
--- --- -------- 1.0 jsr 07/17/17 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditx/examples/xv_sditx_example_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditx.c This is the main
file for Xilinx SDI TX core. Please see xv_sditx.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 jsr 07/17/17 Initial release. jsr 02/23/2018 YUV420 color format support
2.0 vve 10/03/18 Add support for ST352 in C Stream jsr 10/05/18 Moved 3GB
specific video modes timing parameters from video common library to SDI common
driver </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditx/src/xv_sditx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditx.h <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 jsr 07/17/17 Initial
release. jsr 02/23/2018 YUV420 color format support. 2.0 vve 10/03/18 Add
support for ST352 in C Stream </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditx/src/xv_sditx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditx_hw.h This header file
contains identifiers and register-level core functions (or macros) that can be
used to access the Xilinx SDI TX core. For more information about the operation
of this core see the hardware specification and documentation in the higher
level driver xv_sditx.h file. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.0 jsr 07/17/17 Initial release. 2.0 vve 10/03/18 Add
support for ST352 in C Stream </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditx/src/xv_sditx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditx_intr.c This file
contains interrupt related functions for Xilinx SDI TX core. Please see
xv_sditx.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.0 jsr 07/17/17 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditx/src/xv_sditx_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditx_selftest.c @addtogroup
xv_sditx_v1_1 @{ Contains diagnostic/self-test functions for the SDI Tx
Controller core. <pre> MODIFICATION HISTORY: Ver Who Date Changes --- ---
-------- 1.0 jsr 07/17/17 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditx/src/xv_sditx_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditx_sinit.c This file
contains static initialization method for Xilinx SDI TX core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 jsr 07/17/17 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditx/src/xv_sditx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History ver who Date
Changes ----- ---- -------- 1.1 jsr 07/17/17 Created 2.0 kar 01/18/18 Second
Release 2.1 jsr 10/01/18 Fix for 486i SD mode 3.0 vve 10/03/18 Add support for
ST352 in C Stream

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/data/v_sditxss.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss_selftest_example.c
@addtogroup xv_sditxss_v1_0 @{ This file contains a design example using the
XV_SdiTxSs driver. It performs a self test on the SDI Tx Subsystem that will
test its sub-cores self test functions. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes --- --- -------- 1.0 jsr 07/17/17 Initial release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xv_sditxss_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file platform.c This is the
platform source file used in the SDI example design. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- ---- ---------- 1.0 ssh 07/05/2018 Initial version
</pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/platform.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file platform.h This is the
platform header file used in the SDI example design. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- ---- ---------- 1.0 ssh 07/05/2018 Initial version
</pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/platform.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file platform_config.h This is the
platform configuration file used in the SDI example design. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- ---------- 1.0 ssh 07/05/2018 Initial
version </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/platform_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si570drv.c This file contains
low-level driver functions for controlling the SiliconLabs Si570 clock generator
as mounted on the ZCU106 demo board. The user should refer to the hardware
device specification for more details of the device operation. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- ---------- 1.0 ssh
07/05/2018 Initial release. </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/si570drv.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file si570drv.h This file contains
definitions for low-level driver functions for controlling the SiliconLabs Si570
clock generator as mounted on the ZCU106 demo board. The user should refer to
the hardware device specification for more details of the device operation.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- ---------- 1.00 ssh
07/05/2018 Initial release </pre> /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/si570drv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_example.c This file
demonstrates how to use Xilinx SDI Rx Subsystem for standalone. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 ssh
07/05/18 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/xsdi_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_menu.c This file
contains the Xilinx Menu implementation as used in the SDI example design.
Please see xsdi_menu.h for more details. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- ---------- 1.0 ssh 07/05/2018 Initial release </pre> /
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/xsdi_menu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xsdi_menu.h This is the main
header file for the Xilinx Menu implementation as used in the SDI example
design. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- ---- ----------
1.0 ssh 07/05/2018 Initial version </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/examples/xuhdsdi_pixco_example/xsdi_menu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss.c This is the main
file for Xilinx SDI TX core. Please see xv_sditxss.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 jsr 07/17/17 Initial release. 2.00 kar 01/25/18 Second release. jsr
02/23/2018 Added YUV420 color format support jsr 03/02/2018 Added core settings
API 2.1 jsr 07/03/2018 Corrected 720x480_60_I to be 720x486_60_I for SD mode 2.2
jsr 10/01/2018 Programming the Field register for 720x480_60_I SD mode 3.0 vve
10/03/18 Add support for ST352 in C Stream </pre> / Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss.h This is main
header file of the Xilinx SDI TX Subsystem driver <b>SDI Transmitter Subsystem
Overview</b> SDI TX Subsystem is a collection of IP cores bounded together by
software to provide an abstract view of the processing pipe. It hides all the
complexities of programming the underlying cores from end user. <b>Subsystem
Driver Features</b> SDI Subsystem supports following features - AXI Stream
Input/Output interface - 2 pixel-wide video interface - 10 bits per component -
YCbCr color space - Up to 4k2k 60Hz resolution at both Input and Output
interface - Interlaced output support (1080i 50Hz/60Hz) <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 jsr 07/17/17 Initial
release. 2.00 kar 01/25/18 Second release. jsr 03/02/2018 Added core settings
API 3.0 vve 10/03/18 Add support for ST352 in C Stream </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss_coreinit.c
@addtogroup v_sditxss_v1_1 @{ @details SDI TX Subsystem Sub-Cores initialization
The functions in this file provides an abstraction from the initialization
sequence for included sub-cores. Subsystem is assigned an address and range on
the axi-lite interface. This address space is condensed where-in each sub-core
is at a fixed offset from the subsystem base address. For processor to be able
to access the sub-core this offset needs to be transalted into a absolute
address within the subsystems addressable range <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 jsr 07/17/17 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss_coreinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss_coreinit.h
@addtogroup v_sditxss_v1_1 @{ This header file contains the sdi tx subsystem
sub-cores initialization routines and helper functions. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 jsr 07/17/17 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss_coreinit.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss_log.c @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 jsr
07/17/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss_log.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss_selftest.c
@addtogroup xv_sditxss_v1_1 @{ This file contains self test function for the SDI
Tx Subsystem <pre> MODIFICATION HISTORY: Ver Who Date Changes --- --- --------
1.0 jsr 07/17/17 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_sditxss_sinit.c This file
contains static initialization method for Xilinx SDI TX core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 jsr 07/17/17 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_sditxss/src/xv_sditxss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file main.c This file demonstrates
the example usage of TPG IP available in catalogue Please refer v_tpg example
design guide for details on HW setup <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 vyc 09/11/15 Initial Release 1.10 rco 10/05/15
Update to support multiple PPC configurations 8.0 ms 01/23/17 Modified
xil_printf statement in main function to ensure that "Successfully ran" and
"Failed" strings are available in all examples. This is a fix for CR-965028.
</pre>

FILES:
XilinxProcessorIPLib/drivers/v_tpg/examples/main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_vcresampler_coeff.c
@addtogroup v_vcresampler_v3_0 @{ @details This file provides the default fixed
coefficient sets for supported taps <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 rco 07/31/15 Initial Release 3.0 rco 02/09/17
Fix c++ compilation warnings </pre>

FILES:
XilinxProcessorIPLib/drivers/v_vcresampler/src/xv_vcresampler_coeff.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_vcresampler_l2.c @addtogroup
v_vcresampler_v3_0 @{ @details The Vertical Chroma Resampler Layer-2 Driver. The
functions in this file provides an abstraction from the register peek/poke
methodology by implementing most common use-case provided by the sub-core. See
xv_vvcresampler_l2.h for a detailed description of the layer-2 driver <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release 2.00 rco 11/05/15 Integrate layer-1 with layer-2 2.10 rco
07/20/16 Add passthrough mode support rco 02/09/17 Fix c++ compilation warnings
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_vcresampler/src/xv_vcresampler_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_vcresampler_l2.h @addtogroup
v_vcresampler_v3_0 @{ @details This header file contains layer 2 API's of the
vertical chroma resampler sub-core driver.The functions contained herein
provides a high level implementation of features provided by the IP, abstracting
away the register level details from the user <b>V Chroma Resampler IP Features
</b> The vertical chroma resampler IP supports following features - convert
YUV420 -> YUV422 and YUV422 -> YUV420 - Supports resolution up to 4k2k 60Hz - up
to 16 bits color depth - 1, 2 or 4 pixel per clock processing <b>Dependency</b>
This driver makes use of the video enumerations and data types defined in the
Xilinx Video Common Driver (video_common_vX.x) and as such the common driver
must be included as dependency to compile this driver <b>Initialization &
Configuration</b> The device driver enables higher layer software (e.g., an
application) to communicate to the vcresampler core. Before using the layer-2
API's user must initialize the core by calling Layer-1 API
XV_vcresampler_Initialize(). This function will look for a configuration
structure for the device and initialize it to defined HW settings. After
initialization Layer-2 API's can be used to configure the core. It is
recommended user always make use of Layer-2 API to interact with this core.
Advanced users always have the capability to directly interact with the IP core
using Layer-1 API's that perform low level register peek/poke. <b> Interrupts
</b> This driver does not have any interrupts <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 rc 07/21/15 Initial Release 2.00 rco
11/05/15 Integrate layer-1 with layer-2 </pre>

FILES:
XilinxProcessorIPLib/drivers/v_vcresampler/src/xv_vcresampler_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdecap.c This is the main file
for Xilinx VoIP Decapsulator core. Please see xdecap.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 mmo 02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_decap/src/xdecap.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdecap.h This is the main
header file for VoIP Decapsulator core. VoIP Decapsulator core is used for
Incoming Packet Filter, Header Stripping and SDI Video Detection. The VoIP
Decapsulator has 3 main Interface - AXI4-Stream Interface for accepting Incoming
Ethernet Packet - AXI4-Stream Interface for transmitting RTP Packet <RTP Header
| Payload> - AXI4-Lite interface for processor, controls the VoIP Decapsulator.
VoIP Decapsulator Performs Following Operation - Filtering Packet to Channel
based on Incoming Ethernet Packet Header - Striping Incoming Ethernet Header
(MAC,IP & UDP) to form RTP Packet - SDI Video Information Extraction and
Detection on Ethernet Packet (ST2022) <b>Software Initialization &
Configuration</b> The application needs to do following steps in order for
preparing the VoIP Decapsulator core to be ready. - Call XDecap_LookupConfig
using a device ID to find the core configuration. - Call XDecap_CfgInitialize to
initialize the device and the driver instance associated with it. This driver
provides interrupt handlers - XDecap_IntrHandler, for handling the interrupts
from the VoIP Decapsulator core Application developer needs to register
interrupt handler with the processor, within their examples. Whenever processor
calls registered application's interrupt handler associated with interrupt id,
application's interrupt handler needs to call appropriate peripheral interrupt
handler reading peripherals Status register. This driver provides
XDecap_SetCallback API to register functions with Generic Decap core instance.
<b> Virtual Memory </b> <b> Threads </b> <b> Asserts </b> <b> Building the
driver </b> The VoIP Decapsulator driver is composed of several source files.
This allows the user to build and link only those parts of the driver that are
necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00 mmo 02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_decap/src/xdecap.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdecap_hw.h This header file
contains identifiers and register-level core functions (or macros) that can be
used to access the Xilinx VoIP Decapsulator core. For more information about the
operation of this core see the hardware specification and documentation in the
higher level driver xdecap.h file. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 mmo 02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_decap/src/xdecap_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdecap_intr.c This file
contains interrupt related functions for Xilinx VoIP Decapsulator core. Please
see xdecap.h for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 mmo 02/12/16 Initial release. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_decap/src/xdecap_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdecap_sinit.c This file
contains static initialization method for Xilinx VoIP Decapsulator core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_decap/src/xdecap_sinit.c
XilinxProcessorIPLib/drivers/v_voip_fec_rx/src/xvoipfec_rx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpacketizer56.c This is the
main file for Xilinx VoIP ST2022-6 Packetizer core. Please see xpacketizer56.h
for more details of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 mmo 02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_depacketizer56/src/xdepacketizer56.c
XilinxProcessorIPLib/drivers/v_voip_packetizer56/src/xpacketizer56.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file XDepacketizer56.h This is the
main header file for VoIP ST2022-6 Depacketizer core. VoIP ST2022-6 Depacketizer
core is used to map Incoming ST2022-5 RTP Packet in to SDI to AXI4-Stream
Packet. The VoIP ST2022-6 Depacketizer has 3 main Interface - AXI4-Stream
Interface for accepting Incoming SDI to AXI4-Stream Packet - AXI4-Stream
Interface for transmitting RTP Packet <RTP Header | Payload> - AXI4-Lite
interface for processor, controls the VoIP ST2022-6 Depacketizer. VoIP ST2022-6
Depacketizer Performs Following Operation - Map/Convert ST2022-5 RTP Packet in
to SDI to AXI4-Stream Packet <b>Software Initialization & Configuration</b> The
application needs to do following steps in order for preparing the VoIP ST2022-6
Depacketizer core to be ready. - Call XDepacketizer56_LookupConfig using a
device ID to find the core configuration. - Call XDepacketizer56_CfgInitialize
to initialize the device and the driver instance associated with it. This driver
provides interrupt handlers - XDepacketizer56_IntrHandler, for handling the
interrupts from the VoIP ST2022-6 Depacketizer core Application developer needs
to register interrupt handler with the processor, within their examples.
Whenever processor calls registered application's interrupt handler associated
with interrupt id, application's interrupt handler needs to call appropriate
peripheral interrupt handler reading peripherals Status register. This driver
provides XDepacketizer56_SetCallback API to register functions with VoIP
ST2022-6 Depacketizer core instance. <b> Virtual Memory </b> <b> Threads </b>
<b> Asserts </b> <b> Building the driver </b> The VoIP ST2022-6 Depacketizer
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo 02/12/16 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_depacketizer56/src/xdepacketizer56.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdepacketizer56_hw.h This
header file contains identifiers and register-level core functions (or macros)
that can be used to access the Xilinx VoIP ST2022-6 Depacketizer core. For more
information about the operation of this core see the hardware specification and
documentation in the higher level driver xdepacketizer56.h file. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_depacketizer56/src/xdepacketizer56_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdepacketizer56_intr.c This
file contains interrupt related functions for Xilinx VoIP ST2022-6 Depacketizer
core. Please see xdepacketizer56.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_depacketizer56/src/xdepacketizer56_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdepacketizer56_sinit.c This
file contains static initialization method for Xilinx VoIP ST2022-6 Depacketizer
Core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 mmo 02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_depacketizer56/src/xdepacketizer56_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvoipfec_rx.c This is the main
file for Xilinx VoIP FEC Receiver core. Please see xvoipfec_rx.h for more
details of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 mmo 02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_fec_rx/src/xvoipfec_rx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvoipfec_rx.h This is the main
header file for VoIP FEC Receiver core. VoIP FEC Receiver core is used for
ST2022-6 Packet Recovery. The VoIP FEC Receiver has 6 main Interface -
AXI4-Stream Interface for accepting Incoming Ethernet Packet - AXI4-Stream
Interface for transmitting RTP Packet <RTP Header | Payload> - AXI4-Lite
interface for processor, controls the VoIP FEC Receiver. - AXI-MM interface for
External Memory Interface - AXI4-Stream Interface to transmit Event Status of
the Core - AXI4-Stream Interface to receive Packet Request from the Core. VoIP
FEC Receiver Performs Following Operation - Recovers ST2022-6 Packet Loss based
on ST2022-5 Packets - Recovers Network Loss based on ST2022-7 - Buffers and Re-
Order Packet based on the Incoming RTP Sequence Number <b>Software
Initialization & Configuration</b> The application needs to do following steps
in order for preparing the VoIP FEC Receiver core to be ready. - Call
XVoipFEC_RX_LookupConfig using a device ID to find the core configuration. -
Call XVoipFEC_RX_CfgInitialize to initialize the device and the driver instance
associated with it. <b> Virtual Memory </b> <b> Threads </b> <b> Asserts </b>
<b> Building the driver </b> The VoIP FEC Receiver driver is composed of several
source files. This allows the user to build and link only those parts of the
driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 mmo 02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_fec_rx/src/xvoipfec_rx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvoipfec_rx_hw.h This header
file contains identifiers and register-level core functions (or macros) that can
be used to access the Xilinx VoIP FEC Receiver core. For more information about
the operation of this core see the hardware specification and documentation in
the higher level driver xvoipfec_rx.h file. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00 mmo 02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_fec_rx/src/xvoipfec_rx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvoipfec_tx.c This is the main
file for Xilinx VoIP FEC Transmitter core. Please see xvoipfec_tx.h for more
details of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.00 mmo 02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_fec_tx/src/xvoipfec_tx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvoipfec_tx.h This is the main
header file for VoIP FEC Transmitter core. VoIP FEC Transmitter core is used to
generate redundant (FEC:ST2022-1 or ST2022-5) packets based on user configured
setting The VoIP FEC Transmitter has 4 main Interface - AXI4-Stream Interface
for accepting Incoming Ethernet Packet - AXI4-Stream Interface for transmitting
RTP Packet <RTP Header | Payload> - AXI4-Lite interface for processor, controls
the VoIP FEC Transmitter. - AXI-MM interface for External Memory Interface VoIP
FEC Transmitter Performs Following Operation - Generate Redundant Packet
(FEC:ST2022-1 or ST2022-5) <b>Software Initialization & Configuration</b> The
application needs to do following steps in order for preparing the VoIP FEC
Transmitter core to be ready. - Call XVoipFEC_TX_LookupConfig using a device ID
to find the core configuration. - Call XVoipFEC_TX_CfgInitialize to initialize
the device and the driver instance associated with it. <b> Virtual Memory </b>
<b> Threads </b> <b> Asserts </b> <b> Building the driver </b> The VoIP FEC
Transmitter driver is composed of several source files. This allows the user to
build and link only those parts of the driver that are necessary. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_fec_tx/src/xvoipfec_tx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvoipfec_tx_hw.h This header
file contains identifiers and register-level core functions (or macros) that can
be used to access the Xilinx VoIP FEC Transmitter core. For more information
about the operation of this core see the hardware specification and
documentation in the higher level driver xvoipfec_tx.h file. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo 02/12/16 Initial
release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_fec_tx/src/xvoipfec_tx_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvoipfec_tx_sinit.c This file
contains static initialization method for Xilinx VoIP FEC Transmitter core.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_fec_tx/src/xvoipfec_tx_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xframer.c This is the main file
for Xilinx VoIP Framer core. Please see xframer.h for more details of the
driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00 mmo 02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_framer/src/xframer.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xframer.h This is the main
header file for VoIP Framer core. VoIP Framer core is used for generating
Ethernet Headers for Incoming ST2022 RTP Packets or RTP Compliant Packet. The
VoIP Framer has 3 main Interface - AXI4-Stream Interface for accepting Incoming
Ethernet Packet - AXI4-Stream Interface for transmitting RTP Packet <RTP Header
| Payload> - AXI4-Lite interface for processor, controls the VoIP Decapsulator.
VoIP Framer Performs Following Operation - Add Ethernet Header, (MAC, IP, & UDP
Header) - Statistic Monitoring of Incoming and Outgoing Packet <b>Software
Initialization & Configuration</b> The application needs to do following steps
in order for preparing the VoIP Framer core to be ready. - Call
XFramer_LookupConfig using a device ID to find the core configuration. - Call
XFramer_CfgInitialize to initialize the device and the driver instance
associated with it. <b> Virtual Memory </b> <b> Threads </b> <b> Asserts </b>
<b> Building the driver </b> The VoIP Framer driver is composed of several
source files. This allows the user to build and link only those parts of the
driver that are necessary. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 1.00 mmo 02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_framer/src/xframer.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xframer_hw.h This header file
contains identifiers and register-level core functions (or macros) that can be
used to access the Xilinx VoIP Framer core. For more information about the
operation of this core see the hardware specification and documentation in the
higher level driver xframer.h file. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 1.00 mmo 02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_framer/src/xframer_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xframer_sinit.c This file
contains static initialization method for Xilinx VoIP Framer core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_framer/src/xframer_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpacketizer56.h This is the
main header file for VoIP ST2022-6 Packetizer core. VoIP ST2022-6 Packetizer
core is used for Packetized incoming SDI to AXI4-Stream in to ST2022-6 compliant
RTP Packet The VoIP ST2022-6 Packetizer has 3 main Interface - AXI4-Stream
Interface for accepting Incoming SDI to AXI4-Stream Packet - AXI4-Stream
Interface for transmitting RTP Packet <RTP Header | Payload> - AXI4-Lite
interface for processor, controls the VoIP ST2022-6 Packetizer. VoIP ST2022-6
Packetizer Performs Following Operation - Packetized SDI to AXI4-Stream Packet
into ST2022-6 RTP Packet - Add user configured RTP Header into RTP Packet Header
<b>Software Initialization & Configuration</b> The application needs to do
following steps in order for preparing the VoIP ST2022-6 Packetizer core to be
ready. - Call XPacketizer56_LookupConfig using a device ID to find the core
configuration. - Call XPacketizer56_CfgInitialize to initialize the device and
the driver instance associated with it. This driver provides interrupt handlers
- XPacketizer56_IntrHandler, for handling the interrupts from the VoIP ST2022-6
Packetizer core Application developer needs to register interrupt handler with
the processor, within their examples. Whenever processor calls registered
application's interrupt handler associated with interrupt id, application's
interrupt handler needs to call appropriate peripheral interrupt handler reading
peripherals Status register. This driver provides XPacketizer56_SetCallback API
to register functions with VoIP ST2022-6 Packetizer core instance. <b> Virtual
Memory </b> <b> Threads </b> <b> Asserts </b> <b> Building the driver </b> The
VoIP ST2022-6 Packetizer driver is composed of several source files. This allows
the user to build and link only those parts of the driver that are necessary.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_packetizer56/src/xpacketizer56.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpacketizer56_hw.h This header
file contains identifiers and register-level core functions (or macros) that can
be used to access the Xilinx VoIP ST2022-6 Packetizer core. For more information
about the operation of this core see the hardware specification and
documentation in the higher level driver xpacketizer56.h file. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/v_voip_packetizer56/src/xpacketizer56_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpacketizer56_intr.c This file
contains interrupt related functions for Xilinx VoIP ST2022-6 Packetizer core.
Please see xpacketizer56.h for more details of the driver. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo 02/12/16 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_packetizer56/src/xpacketizer56_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpacketizer56_sinit.c This file
contains static initialization method for Xilinx VoIP ST2022-6 Packetizer core.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00 mmo
02/12/16 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_voip_packetizer56/src/xpacketizer56_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_vscaler_coeff.c @addtogroup
v_vscaler_v3_0 @{ @details This file provides the default fixed coefficient sets
for supported taps <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 rco 07/31/15 Initial Release 3.0 rco 02/09/17 Fix c++ compilation
warnings </pre>

FILES:
XilinxProcessorIPLib/drivers/v_vscaler/src/xv_vscaler_coeff.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_vscaler_l2.c @addtogroup
v_vscaler_v3_0 @{ @details The Vertical Scaler Layer-2 Driver. The functions in
this file provides an abstraction from the register peek/poke methodology by
implementing most common use-case provided by the sub-core. See xv_vscaler_l2.h
for a detailed description of the layer-2 driver <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 rco 07/21/15 Initial Release 2.00 rco
11/05/15 Integrate layer-1 with layer-2 3.0 mpe 04/28/16 Added optional color
format conversion handling rco 02/09/17 Fix c++ compilation warnings jsr
09/07/18 Fix for 64-bit driver support </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_vscaler/src/xv_vscaler_l2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xv_vscaler_l2.h @addtogroup
v_vscaler_v3_0 @{ @details This header file contains layer 2 API's of the
verrtical scaler sub-core driver.The functions contained herein provides a high
level implementation of features provided by the IP, abstracting away the
register level details from the user <b>V Scaler IP Features </b> This V-Scaler
IP supports following features - 3 Channel Scaler - Scale vertically to 2K lines
at 60Hz - up to 16bits color depth - 1, 2 or 4 pixel per clock processing
<b>Dependency</b> This driver makes use of the video enumerations and data types
defined in the Xilinx Video Common Driver (video_common_vX.x) and as such the
common driver must be included as dependency to compile this driver
<b>Initialization & Configuration</b> The device driver enables higher layer
software (e.g., an application) to communicate to the vscaler core. Before using
the layer-2 API's user must initialize the core by calling Layer-1 API
XV_vscaler_Initialize(). This function will look for a configuration structure
for the device and initialize it to defined HW settings. After initialization
Layer-2 API's can be used to configure the core. It is recommended user always
make use of Layer-2 API to interact with this core. Advanced users always have
the capability to directly interact with the IP core using Layer-1 API's that
perform low level register peek/poke. <b> Interrupts </b> This driver does not
have any interrupts <b> Virtual Memory </b> This driver supports Virtual Memory.
The RTOS is responsible for calculating the correct device base address in
Virtual Memory space. <b> Threads </b> This driver is not thread safe. Any needs
for threads or thread mutual exclusion must be satisfied by the layer above this
driver. <b>Limitations</b> <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 rco 07/21/15 Initial Release 2.00 rco 11/05/15
Integrate layer-1 with layer-2 3.0 mpe 04/28/16 Added optional color format
conversion handling </pre>

FILES:
XilinxProcessorIPLib/drivers/v_vscaler/src/xv_vscaler_l2.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidc_edid_print_example.c
Contains an example that, given a supplied base Extended Display Identification
Data (EDID) structure, will parse, decode, and print its contents. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als
11/09/14 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/video_common/examples/xvidc_edid_print_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidc_edid_print_example.h
Contains an example that, given a supplied base Extended Display Identification
Data (EDID) structure, will parse, decode, and print its contents. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als
11/09/14 Initial release. </pre>

FILES:
XilinxProcessorIPLib/drivers/video_common/examples/xvidc_edid_print_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidc.c @addtogroup
video_common_v4_3 @{ Contains common utility functions that are typically used
by video-related drivers and applications. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 rc, 01/10/15 Initial
release. als 2.2 als 02/01/16 Functions with pointer arguments that don't modify
contents now const. Added ability to insert a custom video timing table. yh
Added 3D support. 3.0 aad 05/13/16 Added API to search for RB video modes. 3.1
rco 07/26/16 Added extern definition for timing table array Added video-in-
memory color formats Updated XVidC_RegisterCustomTimingModes API signature 4.1
rco 11/23/16 Added new memory formats Added new API to get video mode id that
matches exactly with provided timing information Fix c++ warnings 4.2 jsr
07/22/17 Added new framerates and color formats to support SDI Reordered
YCBCR422 colorforamt and removed other formats that are not needed for SDI which
were added earlier. vyc 10/04/17 Added new streaming alpha formats and new
memory formats 4.3 eb 26/01/18 Added API XVidC_GetVideoModeIdExtensive jsr
02/22/18 Added XVIDC_CSF_YCBCR_420 color space format vyc 04/04/18 Added BGR8
memory format </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/video_common/src/xvidc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidc.h @addtogroup
video_common_v4_3 @{ @details Contains common structures, definitions, macros,
and utility functions that are typically used by video-related drivers and
applications. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 rc, 01/10/15 Initial release. als 2.0 als 08/14/15 Added new
video timings. 2.2 als 02/01/16 Functions with pointer arguments that don't
modify contents now const. Added ability to insert a custom video timing table:
XVidC_RegisterCustomTimingModes XVidC_UnregisterCustomTimingMode yh Added 3D
support. 3.0 aad 05/13/16 Added API to search for RB video modes. als 05/16/16
Added Y-only to color format enum. 3.1 rco 07/26/17 Moved timing table extern
definition to xvidc.c Added video-in-memory color formats Updated
XVidC_RegisterCustomTimingModes API signature 4.1 rco 11/23/17 Added new memory
formats Added xil_printf include statement Added new API
XVidC_GetVideoModeIdWBlanking Fix C++ warnings 4.2 jsr 07/22/17 Added new video
modes, framerates, color formats for SDI New member AspectRatio is added to
video stream structure Reordered XVidC_VideoMode enum variables and corrected
the memory format enums aad 07/10/17 Add XVIDC_VM_3840x2160_60_P_RB video format
vyc 10/04/17 Added new streaming alpha formats and new memory formats aad
09/05/17 Add XVIDC_VM_1366x768_60_P_RB resolution 4.3 eb 26/01/18 Added API
XVidC_GetVideoModeIdExtensive jsr 02/22/18 Added XVIDC_CSF_YCBCR_420 color space
format vyc 04/04/18 Added BGR8 memory format 4.5 jsr 07/03/18 Added
XVIDC_VM_720x486_60_I video format 4.5 yas 03/08/19 Added support for frame
rates 144HZ and 240HZ 4.5 mmo 02/14/19 Added 5k, 8k, 10k and Low Resolution with
200Hz, 240Hz </pre>

FILES:
XilinxProcessorIPLib/drivers/video_common/src/xvidc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidc_edid.c @addtogroup
video_common_v4_2 @{ Contains function definitions related to the Extended
Display Identification Data (EDID) structure which is present in all monitors.
All content in this file is agnostic of communication interface protocol. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
als 11/09/14 Initial release. 2.2 als 02/01/16 Functions with pointer arguments
that don't modify contents now const. 4.0 aad 10/26/16 Added API for colormetry
which returns fixed point in Q0.10 format instead of float. </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/video_common/src/xvidc_edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidc_edid.h @addtogroup
video_common_v4_2 @{ Contains macros, definitions, and function declarations
related to the Extended Display Identification Data (EDID) structure which is
present in all monitors. All content in this file is agnostic of communication
interface protocol. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.0 als 11/09/14 Initial release. 2.2 als 02/01/16 Functions
with pointer arguments that don't modify contents now const. 4.0 aad 10/26/16
Functions which return fixed point values instead of float </pre>

FILES:
XilinxProcessorIPLib/drivers/video_common/src/xvidc_edid.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xhdmi_edid.h <b>Software
Initalization & Configuration</b> <b>Interrupts </b> <b> Virtual Memory </b>
This driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b> Building the driver </b> <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- ---------- 1.0 mmo
24-01-2017 EDID Parser capability </pre>

FILES:
XilinxProcessorIPLib/drivers/video_common/src/xvidc_edid_ext.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

vim: set et fde fdmsyntax ftc.doxygen ts4 sts4 sw4 : / Copyright © 2011 Saleem
Abdulrasool <compnerd@compnerd.org>. All rights reserved. Redistribution and use
in source and binary forms, with or without modification, are permitted provided
that the following conditions are met: 1. Redistributions of source code must
retain the above copyright notice, this list of conditions and the following
disclaimer. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. 3. The name
of the author may not be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / @file
xvidc_parse_edid.c <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---
---------- 1.00 mmo 24-01-2017 Included into video_common 1.01 eb 13-04-2018
Fixed XV_VidC_parse_edid API and xvidc_edid_extension_handler struct to enhance
system stability 1.10 eb 03-08-2018 Updated XV_VidC_parse_edid </pre> /

FILES:
XilinxProcessorIPLib/drivers/video_common/src/xvidc_parse_edid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvidc_timings_table.c
@addtogroup video_common_v4_2 @{ Contains video timings for various standard
resolutions. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 als, 01/10/15 Initial release. rc 2.0 als 08/14/15 Added new
video timings. 2.1 als 11/04/15 Fixed video timings for some resolutions. rco
02/09/17 Fix c++ compilation warnings 4.2 jsr 07/08/17 Added new video timings
for SDI supported resolutions aad 07/10/17 Add XVIDC_VM_3840x2160_60_P_RB video
format aad 09/05/17 Fixed timings for 1366x768_60_P aad 09/05/17 Added
1366x768_60_P_RB 4.4 eb 09/04/18 Fixed timings for 1280x720_24_P, 1280x720_25_P,
1280x720_30_P 4.5 jsr 07/03/18 Added timing for new video mode
XVIDC_VM_720x486_60_I 4.5 mmo 02/14/19 Added 5k, 8k, 10k and Low Resolution with
200Hz, 240Hz </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/video_common/src/xvidc_timings_table.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 als 10/19/15 Initial release. 1.4 gm
29/11/16 Added Transceiver_Width, C_Err_Irq_En, AXI_LITE_FREQ_HZ Parameters
Fixed c++ compiler warnings/errors Added xdefine_config_file for _g.c generation

FILES:
XilinxProcessorIPLib/drivers/vphy/data/vphy.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy.c Contains a minimal set
of functions for the XVphy driver that allow access to all of the Video PHY
core's functionality. See xvphy.h for a detailed description of the driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 als, 10/19/15 Initial release. gm 1.1 gm 02/01/16 Added GTPE2 and GTHE4
support Added more events to XVphy_LogEvent definitions. Added TxBufferBypass in
XVphy_Config structure. Added XVphy_SetDefaultPpc and XVphy_SetPpc functions.
als Added XVphy_GetLineRateHz function. gm 20/04/16 Added XVphy_GetRcfgChId
function 1.2 gm Added HdmiFastSwitch in XVphy_Config Fixed bug in
XVphy_IsPllLocked function Changed EffectiveAddr datatype in XVphy_CfgInitialize
to UINTPTR Used usleep API instead of MB_Sleep API Fixed Null pointer
dereference in XVphy_IBufDsEnable Suppressed warning messages due to unused
arguments 1.4 gm 29/11/16 Moved internally used APIs to xvphy_i.c/h Added
preprocessor directives for sw footprint reduction Fixed c++ compiler warnings
1.6 gm 12/06/17 Changed FAILURE return value of XVphy_DrpRead to 0xDEAD Added
XVphy_DrpRd, XVphy_SetErrorCallback, XVphy_SetPllLayoutErrorCallback and
XVphy_RegisterDebug APIs Added filter in XVphy_MmcmStart to prevent MMCM from
starting when divider values are invalid 1.7 gm 13/09/17 Added GTYE4 support
Updated XVphy_MmcmStart to be able to support a system with active HDMI and DP
Added xvphy_mmcme2/3/4.c drivers to move MMCM configuration from RTL to SW Moved
XVphy_MmcmWriteParameters to xvphy_mmcme2/3/4.c Added XVphy_SetPolarity,
XVphy_SetPrbsSel and XVphy_TxPrbsForceError APIs 1.8 gm 05/14/18 Removed
XVphy_DrpWrite and XVphy_DrpRead APIs 23/07/18 Added APIs
XVphy_SetTxVoltageSwing and XVphy_SetTxPreEmphasis from xvphy_i.c/h Added
XVphy_SetTxPostCursor API 1.9 gm 14/05/18 Added XVphy_SetRxLpm from xvphy_i.c/.h
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy.h @addtogroup xvphy_v1_7
@{ @details This is main header file of the Xilinx Video PHY Controller driver
<b>Video PHY Controller Overview</b> The PHY is intended to simplify the use of
serial transceivers and adds domain-specific configurability. The Video PHY
Controller IP is not intended to be used as a stand alone IP and must be used
with Xilinx Video MACs such as HDMI 1.4/2.0 Transmitter/Receiver Subsystems and
DisplayPort TX/RX Subsystems. The core enables simpler connectivity between MAC
layers for TX and RX paths. However, it is still important to understand the
behavior, usage, and any limitations of the transceivers. See the device
specific transceiver user guide for details. <b>Video PHY Controller Driver
Features</b> Video PHY Controller driver supports following features - Xilinx
DisplayPort and HDMI MAC IPs - GTXE2, GTPE2, GTHE2, GTHE3, GTHE4 and GTYE4 GT
types - HDMI: - 2 or 4 pixel-wide video interface - 8/10/12/16 bits per
component - RGB & YCbCr color space - Up to 4k2k 60Hz resolution at both Input
and Output interface <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 10/19/15 Initial release. 1.1 gm 02/01/16 Added EAST, WEST,
PLL0 and PLL1 definitions for GTPE2. Added more events to XVphy_LogEvent
definitions Added TxBufferBypass in XVphy_Config structure Added
XVphy_SetDefaultPpc and XVphy_SetPpc functions als Added XVphy_GetLineRateHz
function. 1.2 gm Added HdmiFastSwitch in XVphy_Config Changed EffectiveAddr
datatype in XVphy_CfgInitialize to UINTPTR Added log events for debugging 1.2 gm
11/11/19 Added TransceiverWidth in XVphy_Config 1.4 gm 29/11/16 Moved internally
used APIs to xvphy_i.c/h Added preprocessor directives for sw footprint
reduction Made debug log optional (can be disabled via makefile) Added ERR_IRQ
type_defs (not for official use for Xilinx debugging) Added transceiver width,
AXIlite clk frequency and err_irq in XVphy_Config 1.5 gm 08/05/17 Added
DrpClkFreq in XVphy_Config 1.6 gm 06/08/17 Added XVPHY_LOG_EVT_HDMI20_ERR &
XVPHY_LOG_EVT_DRU_CLK_ERR XVphy_LogEvent enum Added intr events for TX and RX
MMCM lock Marked XVphy_DrpWrite and XVphy_DrpRead as deprecated Added
XVphy_SetErrorCallback API Changed ClkOutxDiv declaration to u16 Marked
XVphy_HdmiInitialize deprecated and replaced by XVphy_Hdmi_CfgInitialize 1.7 gm
13/09/17 Added GTYE4 support Added XVphy_SetPolarity, XVphy_SetPrbsSel and
XVphy_TxPrbsForceError APIs 1.8 gm 05/14/18 Updated CDR values for DP in
xvphy_gtye4.c Removed XVphy_DrpWrite and XVphy_DrpRead APIs 23/07/18 Added APIs
XVphy_SetTxVoltageSwing and XVphy_SetTxPreEmphasis from xvphy_i.c/h Added
XVphy_SetTxPostCursor API 1.9 gm 14/05/18 Added XVphy_SetRxLpm from xvphy_i.c/.h
Removed deprecated XVphy_HdmiInitialize API </pre>

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_dp.c This file contains
video PHY functionality specific to the DisplayPort protocol. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 vkd 10/19/15
Initial release. 1.2 gm 08/26/16 Suppressed warning messages due to unused
arguments 1.4 gm 29/11/16 Added preprocessor directives for sw footprint
reduction Added XVphy_GtUserRdyEnable for TX and RX in XVphy_DpInitialize API
1.6 gm 30/06/17 Disable intelligent refclk selection for GTHE3 in
XVphy_DpInitialize Changed xil_printf new lines to \r\n </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_dp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_hdmi.h The Xilinx Video
PHY (VPHY) driver. This driver supports the Xilinx Video PHY IP core. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
vkd 10/19/15 Initial release. 1.7 gm 09/01/18 Added 8.1 Gbps support </pre>
@addtogroup xvphy_v1_7 @{

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_dp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_gt.h The Xilinx Video PHY
(VPHY) driver. This driver supports the Xilinx Video PHY IP core. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als
10/19/15 Initial release. 1.1 gm 02/01/16 Added Gtpe2Config and Gtpe4Config
variables. 1.4 gm 29/11/16 Added preprocessor directives for sw footprint
reduction Changed TX reconfig hook from TxPllRefClkDiv1Reconfig to TxChReconfig
Fixed c++ compiler warnings Added xcvr adaptor functions for C++ compilations
1.7 gm 13/09/17 Added GTYE4 support </pre> @addtogroup xvphy_v1_7 @{

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_gt.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_gthe2.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 10/19/15 Initial release. 1.2 gm 08/26/16 Suppressed warning
messages due to unused arguments 1.4 gm 29/11/16 Added preprocessor directives
for sw footprint reduction Changed TX reconfig hook from TxPllRefClkDiv1Reconfig
to TxChReconfig Corrected the default return value of DRP encoding APIs to
prevent overwritting the reserved bits 1.6 gm 12/06/17 Changed XVphy_DrpRead
with XVphy_DrpRd Changed XVphy_DrpWrite with XVphy_DrpWr Improved status return
of APIs with DRP Rd and Wr </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_gthe2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_gthe3.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 19/10/15 Initial release. 1.1 gm 18/03/16 Added
XVphy_Gthe3RxPllRefClkDiv1Reconfig function 1.2 gm 26/08/16 Suppressed warning
messages due to unused arguments 1.4 gm 29/11/16 Added preprocessor directives
for sw footprint reduction Changed TX reconfig hook from TxPllRefClkDiv1Reconfig
to TxChReconfig Added TX datawidth dynamic reconfiguration Added N28 divider for
CPLL for DP Added CPLL_CFGx reconfiguration in XVphy_Gthe3ClkChReconfig API
Corrected the default return value of DRP encoding APIs to prevent overwritting
the reserved bits 1.6 gm 12/06/17 Changed XVphy_DrpRead with XVphy_DrpRd Changed
XVphy_DrpWrite with XVphy_DrpWr Improved status return of APIs with DRP Rd and
Wr Added N28 divider for CPLL for HDMI 1.7 gm 13/09/17 Disabled intelligent
clock sel in QPLL0/1 configuration Updated DP CDR config for 8.1 Gbps Updated
XVPHY_QPLL0_MAX to 16375000000LL 1.8 gm 05/09/18 Enable IPS only when
XVphy_GetRefClkSourcesCount returns more than 1. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_gthe3.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_gthe4.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 19/10/15 Initial release. 1.1 gm 18/03/16 Added
XVphy_Gthe4RxPllRefClkDiv1Reconfig function Added XVphy_Gthe4TxChReconfig
function Corrected RXCDRCFG2 values 1.2 gm 26/08/16 Suppressed warning messages
due to unused arguments 1.4 gm 29/11/16 Added preprocessor directives for sw
footprint reduction Changed TX reconfig hook from TxPllRefClkDiv1Reconfig to
TxChReconfig Added TX datawidth dynamic reconfiguration Added N28 divider for
CPLL for DP Added CPLL_CFGx reconfiguration in XVphy_Gthe4ClkChReconfig API
Corrected the default return value of DRP encoding APIs to prevent overwritting
the reserved bits 1.5 gm 27/04/17 Updated the RXPI_CFG0 according to new GTWiz
rules Corrected RXCDR_CFG values for DP Added XVphy_CfgCpllCalPeriodandTol API
1.6 gm 12/06/17 Changed XVphy_DrpRead with XVphy_DrpRd Changed XVphy_DrpWrite
with XVphy_DrpWr Improved status return of APIs with DRP Rd and Wr Added N28
divider for CPLL for HDMI 1.7 gm 13/09/17 Disabled intelligent clock sel in
QPLL0/1 configuration Updated DP CDR config for 8.1 Gbps Updated XVPHY_QPLL0_MAX
to 16375000000LL 1.8 gm 05/09/18 Enable IPS only when
XVphy_GetRefClkSourcesCount returns more than 1. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_gthe4.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_gtpe2.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 10/19/15 Initial release. 1.1 gm 03/18/16 Added
XVphy_Gtpe2RxPllRefClkDiv1Reconfig function 1.2 gm 08/26/16 Suppressed warning
messages due to unused arguments 1.4 gm 29/11/16 Added preprocessor directives
for sw footprint reduction Changed TX reconfig hook from TxPllRefClkDiv1Reconfig
to TxChReconfig Added TX datawidth dynamic reconfiguration Corrected the default
return value of DRP encoding APIs to prevent overwritting the reserved bits 1.6
gm 12/06/17 Changed XVphy_DrpRead with XVphy_DrpRd Changed XVphy_DrpWrite with
XVphy_DrpWr Improved status return of APIs with DRP Rd and Wr </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_gtpe2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_gtxe2.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 als 10/19/15 Initial release. 1.1 gm 12/07/15 Corrected
PllParams.Cdr[1] values for DP and HDMI gm 03/18/16 Added
XVphy_Gtxe2RxPllRefClkDiv1Reconfig function 1.4 gm 29/11/16 Added preprocessor
directives for sw footprint reduction Changed TX reconfig hook from
TxPllRefClkDiv1Reconfig to TxChReconfig Added TX datawidth dynamic
reconfiguration Corrected the default return value of DRP encoding APIs to
prevent overwritting the reserved bits 1.6 gm 12/06/17 Changed XVphy_DrpRead
with XVphy_DrpRd Changed XVphy_DrpWrite with XVphy_DrpWr Improved status return
of APIs with DRP Rd and Wr </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_gtxe2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_gtye4.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.7 gm 13/09/17 Initial release. 1.8 gm 14/05/18 Updated CDR values for
DP 05/09/18 Enable IPS only when XVphy_GetRefClkSourcesCount returns more than
1. 1.9 gm 14/05/18 Added CDR_CFG3 configuration for DP </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_gtye4.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_hdmi.c This file contains
video PHY functionality specific to the HDMI protocol. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 gm 10/19/15
Initial release. 1.1 gm 02/01/16 Added GTPE2 and GTHE4 support. MG 03/08/16
Fixed issue in function XVphy_HdmiCfgCalcMmcmParam for single pixel calculation.
1.2 gm Added XVphy_HdmiMmcmStart and XVphy_HdmiMmcmWriteParameters functions
Replaced xil_printf with log events Modified XVphy_DruGetRefClkFreqHz Suppressed
warning messages due to unused arguments 1.3 gm 01/11/16 Added error message in
XVphy_HdmiCpllParam when DRU is enabled and RX TMDS ratio is 1/40 Fixed rounding
of DRU refclk frequency Fixed a bug in XVphy_SetHdmiRxParam to update the ChId
when DRU is enabled 1.4 gm 29/11/16 Added preprocessor directives for sw
footprint reduction Added TX datawidth dynamic reconfiguration Incorporated
AXIlite Freq auto extraction Added extra routine for 2/4 byte tranceiver modes
Added logging and register access for ERR_IRQ impl Removed XVphy_HdmiMmcmStart
API Fixed c++ compiler warnings 1.5 gm 27/04/17 Added Div in
HdmiCfgCalcMmcmParam search algorithm 1.6 gm 06/08/17 Added
XVPHY_LOG_EVT_HDMI20_ERR error condition in HdmiCfgCalcMmcmParam for GTPE2
Removed XVPHY_LOG_EVT_VDCLK_HIGH_ERR error from HdmiCfgCalcMmcmParam since it
falls under HDMI20_ERR Added interrupt initialization for TX and RX MMCM lock
Removed printing QPLL0 in debug info for GTXE2 Set different target DRU line
rates for QPLL and CPLL for GTXE2 Implemented TX and RX Only uses-cases in
XVphy_HdmiDebugInfo API Fixed bug in HdmiCfgCalcMmcmParam when linerate exceeds
3.4 Gbps when oversampling is enabled Changed xil_printf new lines to \r\n
Marked XVphy_HdmiInitialize deprecated and replaced by XVphy_Hdmi_CfgInitialize
Added XVPHY_LOG_EVT_DRU_CLK_ERR error condition to report when DRU REFCLK is
out-of-range 1.7 gm 13/09/17 Added GTYE4 support. Added userclk freq checking in
XVphy_HdmiCpllParam & XVphy_HdmiQpllParam API Removed XVphy_DruSetGain API 1.8
gm 05/14/18 Fixed a bug in XVphy_HdmiQpllParam where linerate is obtained from
CH1 instead of QPLL0/1 1.9 gm 14/05/18 Added TX and RX MMCM lock event logging
Removed deprecated XVphy_HdmiInitialize API </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_hdmi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_hdmi.h The Xilinx Video
PHY (VPHY) driver. This driver supports the Xilinx Video PHY IP core. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
gm 10/19/15 Initial release. 1.1 gm 02/01/16 Added GTPE2 and GTHE4 constants 1.2
gm Added XVphy_HdmiMmcmStart function 1.4 gm 29/11/16 Added preprocessor
directives for sw footprint reduction Removed XVphy_HdmiMmcmStart API Corrected
GTPE2 DRU REFCLK range 1.6 gm 03/07/17 Added XVPHY_HDMI_GTXE2_DRU_LRATE_Q/CPLL
definitions Corrected FVCO range for MMCME4 1.7 gm 13/09/17 Removed
XVphy_DruSetGain API </pre> @addtogroup xvphy_v1_7 @{

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_hdmi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_hdmi_intr.c This file
contains video PHY functionality specific to the HDMI protocol related to
interrupts. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 gm 10/19/15 Initial release. 1.1 gm 02/01/16 Added GTPE2 and
GTHE4 support Added XVphy_HdmiGtpPllLockHandler for GTPE2 1.2 gm Replaced
xil_printf with log events for debugging 1.3 gm 01/11/16 Fixed rounding of RX
refclk frequency Fixed race condition in XVphy_HdmiRxClkDetFreqChangeHandler
when storing RxRefClkHz value 1.4 gm 29/11/16 Added preprocessor directives for
sw footprint reduction Incorporated AXIlite Freq auto extraction Added logging
and register access for ERR_IRQ impl Added mechanism to re-trigger GT TX reset
when TX align get stuck Fixed c++ compiler warnings 1.6 gm 06/08/17 Prevented TX
reset on bonded mode and when DRU is active in
XVphy_HdmiGtRxResetDoneLockHandler API Added TX and RX MMCM Lock handling
Improved TX initialization flow in bonded mode to reset GT TX only when PLL and
MMCM are locked 1.7 gm 13/09/17 Added GTYE4 support 1.9 gm 14/05/18 Added TX and
RX MMCM lock event logging </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_hdmi_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_hw.h This header file
contains the identifiers and low-level driver functions (or macros) that can be
used to access the device. High-level driver functions are defined in xvphy.h.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 als 10/19/15 Initial release. 1.1 gm 02/01/16 Added GTPE2 and GTHE4 support
1.4 gm 29/11/16 Added ERR_IRQ register offset 1.5 gm 02/05/17 Added CPLL CAL reg
and corresponding masks 1.6 gm 06/08/17 Added TX and RX MMCM lock Masks 1.7 gm
13/09/17 Added GTYE4 support </pre> @addtogroup xvphy_v1_7 @{

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_i.c Contains generic APIs
that are locally called or used within the VPHY driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 gm, 11/09/16
Initial release. 1.4 gm 29/11/16 Fixed c++ compiler warnings Added xcvr adaptor
functions for C++ compilations 1.6 gm 06/08/17 Added XVphy_MmcmLocked,
XVphy_ErrorHandler and XVphy_PllLayoutErrorHandler APIs 1.7 gm 13/09/17 Added
GTYE4 support 1.8 gm 23/07/18 Moved APIs XVphy_SetTxVoltageSwing and
XVphy_SetTxPreEmphasis to xvphy.c/h 05/09/18 Added XVphy_GetRefClkSourcesCount
API 1.9 gm 11/04/18 Added XVphy_IsHDMI API </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_i.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_i.h Contains generic APIs
that are locally called or used within the VPHY driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- Ver Who Date
Changes ----- ---- -------- 1.0 gm 11/09/16 Initial release. 1.4 gm 11/24/16
Made debug log optional (can be disabled via makefile) 1.5 gm 02/05/17 Added
XVphy_CfgCpllCalPeriodandTol API for US+ devices 1.6 gm 06/08/17 Added
XVphy_MmcmLocked, XVphy_ErrorHandler and XVphy_PllLayoutErrorHandler APIs 1.7 gm
13/09/17 Removed XVphy_MmcmWriteParameters API 1.8 gm 23/07/18 Moved APIs
XVphy_SetTxVoltageSwing and XVphy_SetTxPreEmphasis to xvphy.c/h 05/09/18 Added
XVphy_GetRefClkSourcesCount API 1.9 gm 11/04/18 Added XVphy_IsHDMI API Moved
XVphy_SetRxLpm to xvphy.c/.h </pre> @addtogroup xvphy_v1_7 @{

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_intr.c This file contains
functions related to XVphy interrupt handling. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 10/19/15 Initial
release. 1.4 gm 29/11/16 Added XVphy_CfgErrIntr for ERR_IRQ impl 1.6 gm 06/08/17
Added TX and RX MMCM locked handlers </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy.c Contains a minimal set
of functions for the XVphy driver that allow access to all of the Video PHY
core's functionality. See xvphy.h for a detailed description of the driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 als 10/19/15 Initial release. 1.1 gm 02/01/16 Additional events for event
log printout 1.2 gm Added log events for debugging 1.4 gm 11/24/16 Made debug
log optional (can be disabled via makefile) Added XVPHY_LOG_EVT_TX_ALIGN_TMOUT
log event 1.6 gm 06/08/17 Added XVPHY_LOG_EVT_HDMI20_ERR log event Added Red &
Yellow printing for errors and warnings Added XVPHY_LOG_EVT_NO_QPLL_ERR log
event Changed xil_printf new lines to \r\n Added XVPHY_LOG_EVT_DRU_CLK_ERR log
event 1.7 gm 13/09/17 Added XVPHY_LOG_EVT_USRCLK_ERR event </pre> Include Files
/

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_log.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_mmcme2.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.7 gm 13/09/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_mmcme2.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_mmcme3.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.7 gm 13/09/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_mmcme3.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_mmcme4.c Contains a
minimal set of functions for the XVphy driver that allow access to all of the
Video PHY core's functionality. See xvphy.h for a detailed description of the
driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.7 gm 13/09/17 Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_mmcme4.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_selftest.c This file
contains a diagnostic self-test function for the XVphy driver. It will check
many of the Video PHY's register values against the default reset values as a
sanity-check that the core is ready to be used. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 10/19/15 Initial
release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvphy_sinit.c This file
contains static initialization methods for the XVphy driver. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 als 10/19/15
Initial release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vphy/src/xvphy_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 1.0 rco 07/21/15 Initial version of subsystem
tcl 1.1 rco 11/20/15 Bug fix for designs with single instance of vcresampler
core 1.2 rco 06/06/16 Extended to support multiple instances 08/22/16 Bug fix
for dictionary get without exists check 1.3 rco 12/15/16 Added
C_DEINT_MOTION_ADAPTIVE option to param list

FILES:
XilinxProcessorIPLib/drivers/vprocss/data/vprocss.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file periph.c This is top level
resource file that will initialize all system level peripherals <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rc 07/07/14
First release 2.00 dmc 12/02/15 Removed UART driver instance 01/25/16 Remove
inclusion xdebug.h and use of xdbg_printf() 01/25/16 Support a new GPIO instance
to reset IP inside the VPSS </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/examples/src/periph.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file periph.h This is header for
resource file that will initialize all system level peripherals <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rc 07/07/14
First release 2.00 dmc 12/02/15 Removed UART driver instance 01/25/16 Support
new GPIO instance to reset HLS IP inside the VPSS </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/examples/src/periph.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file system.c This is top level
resource file that will initialize all system level peripherals <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 0.01 rc 07/07/14
First release 1.00 dmc 01/25/16 Initialize the VPSS Event Logging system in
XSys_Init() </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/examples/src/system.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file system.h This is header for top
level resource file that will initialize all system level peripherals <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 0.01 rc 07/07/14
First release </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/examples/src/system.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file main.c This is main file for
the Video Processing Subsystem example design. The VPSS HW configuration is
detected and several use cases are selected to test it. These VPSS HW
characteristics are configurable: Topology: 6 cases - Full fledged, Scaler-only,
... Pixels/clock: 3 cases - 1, 2, 4 Component/Pixel: 1 case - 3 Data
Width/Component: 4 cases - 8, 10, 12, 16 Interlaced input: 2 cases - Allowed,
Not allowed Allow color formats: 3 cases - (RGB,444,422,420), (RGB,444,422),
(RGB,444) Max Width: range is 64...3840 Max Height: range is 64...2160 The video
pipeline in the Example Design HW consists of the Test Pattern Generator driving
the VPSS input. The VPSS output is checked for video lock. On start-up the
program reads the HW config and initializes its internal data structures. Based
on the HW capabilities, 2 use cases are selected. Testing a use case is done by:
1) Select an appropriate video input format, and program the Test Pattern
Generator and the VPSS input stage for this format. 2) Select an appropriate
video output format, and program the VPSS output stage and the Video Timing
Controller for that format. 3) Start the HW, and poll the Lock status bit
waiting for video Lock. If you get Lock, the test reports "PASSED". If there is
no Lock after several seconds the test reports "FAILED" 4) Optionally, go back
and set up the next use case, repeating steps 1,2,3.

FILES:
XilinxProcessorIPLib/drivers/vprocss/examples/src/xv_procss_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss.c This is main code of
Xilinx Video Processing Subsystem device driver. Please see xvprocss.h for more
details of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 rco 08/28/15 Initial Release 2.00 rco 11/05/15 Update to
adapt to sub-core layer 2 changes dmc 12/02/15 Added support for additional
topologies dmc 12/17/15 Rename and modify H,VCresample constants and routines
Modify CSC-only validate and setup routines Modify Scaler-only validate and
setup routines Modifications to conform to coding style dmc 01/11/16 Write to
new Event Log: log status and error events dmc 02/17/16 Modify timing and
placement of axis and aximm resets dmc 02/24/16 Rename some constants and
variables dmc 03/03/16 Init VideoStream structs to 0 in SetPowerOnDefaultState
2.10 mpe 04/28/16 Added optional color format conversion handling in scaler only
topology rco 07/20/16 Replace deprecated MB_Sleep with usleep Maintain user
defined PIP color between pipe reset 2.30 rco 12/15/16 Added HasMADI
configuration option check 02/08/17 Fix C++ compilation warnings 02/15/17 Fix
custom resolution support for 1 PPC configuration 2.40 vyc 10/04/17 Added
support for conversion from 420/422/444/RGB to 420/422/444/RGB with CSC-only
topology 2.50 vyc 04/04/18 Fix for HScaler setup with 420 input </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss.h This is main header
file of the Xilinx Video Processing Subsystem driver <b>Video Processing
Subsystem Overview</b> Video Subsystem is a collection of IP cores bonded
together by software to provide an abstract view of the processing pipe. It
hides all the complexities of programming the underlying cores from end user.
<b>Subsystem Driver Features</b> Video Subsystem supports following features -
AXI Stream Input/Output interface - 1, 2 or 4 pixel-wide video interface -
8/10/12/16 bits per component - RGB & YCbCr color space - Memory based/streaming
mode scaling in either direction (Up/Down) - Up to 4k2k 60Hz resolution at both
Input and Output interface - Interlaced input support (1080i 50Hz/60Hz) - Frame
rate conversion - Drop frames if input rate > output rate - Repeat frames if
input rate < output rate - Auto configuration of processing pipe based on
detected use case - Scale Up/Down - Zoom mode wherein a window in input is
scaled to panel resolution - Picture-In-Picture mode wherein the input stream is
scaled down to a defined window size and background is painted to user define
color - Color Space and color format Conversion - Interlaced to Progressive
conversion <b>Subsystem Configurations</b> Six types of configurations, each
with options, are supported via GUI in IPI - Full Configuration: provides all
the features mentioned above - Five streaming mode configurations have specific
limited functionalities: - Scaler-only mode allows only for changing the picture
size - Deinterlace-only mode allows for converting interlaced to progressive -
Csc-only mode allows only for changing the color space, e.g. YUV to RGB -
Vertical Chroma Resamp-only mode allows only for 420<->422 conversion -
Horizontal Chroma Resamp-only mode allows only for 422<->444 conversion Number
of processing cores that get included in the design will depend upon the
configuration selected. Static configuration parameters are stored in
vprocss_g.c file that gets generated when compiling the board support package
(BSP). A table is defined where each entry contains configuration information
for the instances of the subsystem in the design. This information includes the
elected configuration, sub-cores used and their device ID, base addresses of
memory mapped devices, user specified DDR address for buffer management and
address range available for subsystem frame/field buffers. Full configuration
mode includes following sub-cores in HW - Scalers (horizontal/vertical) -
Deinterlacer - Chroma Resamplers (one horizontal and two vertical) - Color Space
Converter - VDMA for buffer management - Letterbox - AXIS Switch Streaming mode
configurations include the following sub-cores in HW - Scaler-only: Scalers
(horizontal/vertical) - Deinterlace-only: Deinterlacer - Csc-only: Color Space
Converter - Vertical Chroma Resamp-only: One Vertical Chroma Resampler -
Horizontal Chroma Resamp-only: Horizontal Chroma Resampler The subsystem driver
itself always includes the full software stack irrespective of the configuration
selected. Generic API's are provided to interact with the subsystem and/or with
the included sub-cores. At run-time the subsystem will query the static
configuration and configure itself for supported use cases <b>Subsystem Driver
Description</b> Subsystem driver is built upon layer 1&2 device drivers of
included sub-cores Layer 1 provides API's to peek/poke registers at HW level.
Layer 2 provides API's that abstract sub-core functionality, providing an easy
to use feature interface <b>Pre-Requisite's</b> - For memory based design (Full
Fledged Topology with VDMA, and/or Deinterlace with MADi) the application must
program the base address of the video buffers in memory. Refer to Memory
Requirement section below. - For microblaze based designs it is recommended to
include a timer peripheral in the design and application should register a delay
handling routine with the subsystem using the provided API. <b>Subsystem Driver
Usage</b> The subsystem driver in itself is a dormant driver that needs
application SW to make use of provided API's to configure it at boot-up.
Thereafter application SW is responsible to monitor the system for external
impetus and call the subsystem API's to communicate the change and trigger the
reconfiguration of internal data processing pipe (refer to API
XVprocSs_ConfigureSubsystem()) AXI Stream configuration for input/output
interface is derived from the Xilinx video common driver and only the
resolutions listed therein are supported at this time <b>Memory Requirement</b>
For full configuration mode DDR memory is used to store video frame buffers
Subsystem uses 5 frame buffers for Progressive input and 3 field buffers for
interlaced input. The amount of memory required by the subsystem can be
calculated by below equation - 5 MAX_WIDTHp MAX_HEIGHTp NUM_VIDEO_COMPONENTS
BytesPerComp + 3 MAX_WIDTHi MAX_HEIGHTi NUM_VIDEO_COMPONENTS BytesPerComp
BytesPerComp - 1 Byte for 8 bit data pipe - 2 Byte for 10/12/16 bit data pipe
The location of these buffers in the memory is system dependent and as such must
be determined by the system designer and the application code is responsible to
program the base address of the buffer memory prior to initializing the
subsystem. API to use is defined below - XVprocSs_SetFrameBufBaseaddr
<b>Interrupt Service</b> Currently no interrupts are available from the
subsystem. User application is responsible for triggering processing pipe update
when any change in subsystem configuration is performed at application level
<b>Log Capability</b> Subsystem driver implements a logging feature that
captures the interaction between included sub-core(s) as the subsystem is being
configured and started. This is a potenital debugging aid should the system not
behave as expected. If code size becomes a concern this logging capability can
be removed from the driver by defining XV_CONFIG_LOG_VPRCOSS_DISABLE
preprocessor macro in driver/BSP makefile. For maximun code savings logging
capaibility can be disabled, globally, for all included video drivers in BSP by
defining the preprocessor macro XV_CONFIG_LOG_DISABLE_ALL in the BSP makefile.
<b> Virtual Memory </b> This driver supports Virtual Memory. The RTOS is
responsible for calculating the correct device base address in Virtual Memory
space. <b> Threads </b> This driver is not thread safe. Any needs for threads or
thread mutual exclusion must be satisfied by the layer above this driver.
<b>Asserts</b> Asserts are used within all Xilinx drivers to enforce constraints
on argument values. Asserts can be turned off on a system-wide basis by
defining, at compile time, the NDEBUG identifier. By default, asserts are turned
on and it is recommended that application developers leave asserts on during
development. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 rco 08/28/15 Initial Release 2.00 rco 11/05/15 Update to adapt to
sub-core layer 2 changes dmc 12/02/15 Added four new topologies. There are now
six topologies dmc 12/17/15 Accommodate Full topology with no VDMA Rename and
modify H,VCresample constants and routines Add macros to query for the new
topologies dmc 01/11/16 Add new data struct, enums, constants and prototypes to
support a new Event Logging system for xvprocss. 2.10 rco 07/20/16 Add lbox
background color storage to context data Used UINTPTR instead of u32 for
Baseaddress, Frameaddr Changed the prototype of XVprocSs_CfgInitialize and
XVprocSs_SetFrameBufBaseaddr API 2.30 rco 11/15/16 Make debug log optional (can
be disabled via makefile) 12/15/16 Added HasMADI configuration option </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_coreinit.c @addtogroup
vprocss_v2_4 @{ @details Video Processing Subsystem Sub-Cores initialization The
functions in this file provides an abstraction from the initialization sequence
for included sub-cores. Subsystem is assigned an address and range on the axi-
lite interface. This address space is condensed where-in each sub-core is at a
fixed offset from the subsystem base address. For processor to be able to access
the sub-core this offset needs to be transalted into a absolute address within
the subsystems addressable range <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 rco 07/21/15 Initial Release 1.10 rco 11/25/15
Replace bitwise OR with ADD operation when computing subcore absolute address
2.00 dmc 01/11/16 Write to new Event Log: log sub-core init errors </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_coreinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_coreinit.h @addtogroup
vprocss_v2_4 @{ @details This header file contains the video processing engine
sub-cores initialization routines and helper functions. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15 Initial
Release </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_coreinit.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_log.c Contains Event
Logging routines for xvprocss. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 2.00 dmc 01/11/16 Initial release. dmc 03/03/16
Add events for VDMA configuration and operational errors 2.20 rco 11/01/16
Change setup ignore messages (for csc, hscaler, vscaler etc.) severity from Info
to Error 2.30 rco 11/15/16 Make debug log optional (can be disabled via
makefile) 2.40 vyc 10/04/17 Add 420 support in CSC-only topology </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_log.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_log.h @addtogroup
vprocss_v2_4 @{ @details This header file contains the video processing event
log initialization routines and helper functions. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 dmc 01/27/16 Initial Release dmc
03/03/16 Add events for VDMA configuration and operational errors 2.30 rco
11/15/16 Make debug log optional (can be disabled via makefile) </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_log.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_router.c @addtogroup
vprocss_v2_4 @{ @details Video buffer management routine. The functions in this
file provides an abstraction from the register peek/poke methodology by
implementing most common use-case provided by the VDMA sub-core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release 2.00 dmc 12/17/15 Accommodate Full topology with no VDMA Rename
and modify H,VCresample constants and routines Mods to conform to coding sytle
01/11/16 Write to new Event Log: log status and error events The Event Logging
replaces all the printf statements 2.1 mpe 04/28/16 Added optional color format
conversion handling in scaler only topology 2.2 rco 11/01/16 Add log events to
capture failure during router data flow setup 2.4 vyc 10/04/17 Write to Result
for XV_CscSetColorSpace </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_router.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_router.h @addtogroup
vprocss_v2_4 @{ @details This header file contains the video processing engine
data flow setup routines and helper functions. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 rco 07/21/15 Initial Release </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_router.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_sinit.c @addtogroup
vprocss_v2_4 @{ @details This file contains the implementation of the Video
Processing Subsystem driver's static initialization functionality. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/xvprocss_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_vdma.c @addtogroup
vprocss_v2_4 @{ @details Video buffer management routine. The functions in this
file provides an abstraction from the register peek/poke methodology by
implementing most common use-case provided by the VDMA sub-core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15
Initial Release 2.00 dmc 03/03/16 Remove xil_print's and report errors via event
log 2.10 rco 07/21/16 Used UINTPTR instead of u32 for Address 2.3 rco 02/09/17
Fix c++ warnings </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/vdma/xvprocss_vdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvprocss_vdma.h @addtogroup
vprocss_v2_4 @{ @details This header file contains the video processing engine
DMA buffer management routines and helper functions. AXI-VDMA core is used to
provide DMA functionality and the function contained herein provides a high
level implementation of features provided by the IP, abstracting away the low
level core configuration details from the user <b>DMA Features </b> The DMA
supports following features - Abstract AXI-VDMA API to setup/program RD/WR
channel - Start/Stop transfer on all channels with single call <b>Initialization
& Configuration</b> The device driver enables higher layer software to
communicate with the vdma core. Before using these API's subsystem must
initialize the core by calling Layer-1 API's XAxiVdma_LookupConfig(). This
function will look for a configuration structure for the device and
XAxiVdma_CfgInitialize() will initialize it to defined HW settings. After
initialization included API's can be used to configure the core. <b> Interrupts
</b> Currently VDMA core does not generate any interrupts <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 rco 07/21/15 Initial
Release 2.00 dmc 03/03/16 Pass VPSS pointer to routines for event log reporting
2.10 rco 07/21/16 Used UINTPTR instead of u32 for Address </pre>

FILES:
XilinxProcessorIPLib/drivers/vprocss/src/vdma/xvprocss_vdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 6.0 adk 10/12/13 Removed interrupt handler
entry 8.0 jsr 10/01/18 Removed hard coded programming of vactive size values
from driver jsr 10/03/18 Corrected VGA resoution from 656x496 to 640x480

FILES:
XilinxProcessorIPLib/drivers/vtc/data/vtc.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file vtc_selftest_example.c This
file contains an example using the VTC driver to do self test on the core. @note
None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 6.1
adk 08/23/14 First Release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vtc/examples/vtc_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvtc.c @addtogroup vtc_v7_2 @{
This is main code of Xilinx MVI Video Timing Controller (VTC) device driver. The
VTC device detects and generates video sync signals to Video IP cores like MVI
Video Scaler. Please see xvtc.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a xd
08/05/08 First release. 1.01a xd 07/23/10 Added GIER; Added more h/w generic
info into xparameters.h; Feed callbacks with pending interrupt info. Added
Doxygen & Version support. 3.00a cjm 08/01/12 Converted from xio.h to xil_io.h,
translating basic types, MB cache functions, exceptions and assertions to xil_io
format. Replaced the following: "XExc_Init" -> "Xil_ExceptionInit"
"XExc_RegisterHandler" -> "Xil_ExceptionRegisterHandler"
"XEXC_ID_NON_CRITICAL_INT" -> "XIL_EXCEPTION_ID_INT" "XExceptionHandler" ->
"Xil_ExceptionHandler" "XExc_mEnableExceptions" -> "Xil_ExceptionEnable"
"XEXC_NON_CRITICAL" -> "XIL_EXCEPTION_NON_CRITICAL" "XExc_DisableExceptions" ->
"Xil_ExceptionDisable" "XExc_RemoveHandler" -> "Xil_ExceptionRemoveHandler"
"microblaze_enable_interrupts" -> "Xil_ExceptionEnable"
"microblaze_disable_interrupts" -> Xil_ExceptionDisable" "XCOMPONENT_IS_STARTED"
-> "XIL_COMPONENT_IS_STARTED" "XCOMPONENT_IS_READY" ->
"(XIL_COMPONENT_IS_READY)" "XASSERT_NONVOID" -> "Xil_AssertNonvoid"
"XASSERT_VOID_ALWAYS" -> "Xil_AssertVoidAlways" "XASSERT_VOID" ->
"Xil_AssertVoid" "Xil_AssertVoid_ALWAYS" -> "Xil_AssertVoidAlways"
"XAssertStatus" -> "Xil_AssertStatus" "XAssertSetCallback" ->
"Xil_AssertCallback" "XASSERT_OCCURRED" -> "XIL_ASSERT_OCCURRED" "XASSERT_NONE"
-> "XIL_ASSERT_NONE" "microblaze_disable_dcache" -> "Xil_DCacheDisable"
"microblaze_enable_dcache" -> "Xil_DCacheEnable" "microblaze_enable_icache" ->
"Xil_ICacheEnable" "microblaze_disable_icache" -> "Xil_ICacheDisable"
"microblaze_init_dcache_range" -> "Xil_DCacheInvalidateRange"
"XCache_DisableDCache" -> "Xil_DCacheDisable" "XCache_DisableICache" ->
"Xil_ICacheDisable" "XCache_EnableDCache" -> "Xil_DCacheEnableRegion"
"XCache_EnableICache" -> "Xil_ICacheEnableRegion" "XCache_InvalidateDCacheLine"
-> "Xil_DCacheInvalidateRange" "XUtil_MemoryTest32" -> "Xil_TestMem32"
"XUtil_MemoryTest16" -> "Xil_TestMem16" "XUtil_MemoryTest8" -> "Xil_TestMem8"
"xutil.h" -> "xil_testmem.h" "xbasic_types.h" -> "xil_types.h" "xio.h" ->
"xil_io.h" "XIo_In32" -> "Xil_In32" "XIo_Out32" -> "Xil_Out32" "XTRUE" -> "TRUE"
"XFALSE" -> "FALSE" "XNULL" -> "NULL" "Xuint8" -> "u8" "Xuint16" -> "u16"
"Xuint32" -> "u32" "Xint8" -> "char" "Xint16" -> "short" "Xint32" -> "long"
"Xfloat32" -> "float" "Xfloat64" -> "double" "Xboolean" -> "int" "XTEST_FAILED"
-> "XST_FAILURE" "XTEST_PASSED" -> "XST_SUCCESS" 4.00a cjm 02/08/13 Removed
XVTC_CTL_HASS_MASK 5.00a cjm 08/07/13 Replaced CTL in Polarity and Encoding
register definition with "POL" and "ENC" 5.00a cjm 10/30/13 Removed type
parameter from XVtc_Enable which now enables both generator and detector. Added
XVtc_EnableGenerator to enable only the Generator Added XVtc_EnableDetector to
enable only the Detector 5.00a cjm 11/01/13 Added Timing, VideoMode and Signal
Conversion Functions XVtc_ConvVideoMode2Timing XVtc_ConvTiming2Signal
XVtc_ConvSignal2Timing XVtc_ConvTiming2VideoMode Added Timing and Video Mode
Set/Get Functions XVtc_SetGeneratorTiming XVtc_SetGeneratorVideoMode
XVtc_GetGeneratorTiming XVtc_GetGeneratorVideoMode XVtc_GetDetectorTiming
XVtc_GetDetectorVideoMode Updated XVtc_GetGeneratorHoriOffset and
XVtc_SetGeneratorHoriOffset. For adding interlaced or field-1 registers
setting/getting updated XVtc_SetGenerator to align vsync to hsync horizontally
by default. Added Field 1 set/get to XVtc_SetGenerator, XVtc_GetGenerator and
XVtc_GetDetector. 5.00a cjm 11/03/13 Added Chroma/field parity bit masks.
Replaced old timing bit masks/shifts with Start/End Bit masks/shifts. 6.1 adk
08/23/14 Modified HActiveVideo value to 1920 for XVTC_VMODE_1080I mode. Removed
Major, Minor and Revision parameters from XVtc_GetVersion. Modified return type
of XVtc_GetVersion from void to u32. 7.0 vns 25/02/15 Added progressive and
interlaced mode switching feature. Modified XVtc_SetGenerator,
XVtc_GetGenerator, XVtc_GetDetector, XVtc_ConvTiming2Signal and
XVtc_ConvSignal2Timing APIs 7.1 vns 07/10/15 Corrected V0SyncStart and
V1SyncStart values in APIs XVtc_ConvTiming2Signal and XVtc_ConvSignal2Timing
Corrected register read to XVTC_DVSYNC_F1_OFFSET in API XVtc_GetDetector vns
10/14/15 Modified XVtc_SetSource API to provided programming interlaced mode
feature and modified XVtc_GetSource API to read interlaced mode status.
Corrected XVtc_ConvSignal2Timing API to get interlaced mode from SignalCfgPtr
structure. 7.2 mh 04/20/16 Removed call to XVtc_Reset from XVtc_CfgInitialize.
sk 08/16/16 Used UINTPTR instead of u32 for Baseaddress as part of adding 64 bit
support. CR 867425. Changed the prototype of XVtc_CfgInitialize API. 8.0 jsr
07/03/18 Added a new register XVTC_GASIZE_F1_OFFSET for interlaced modes FIELD1
vactive size. This value is same as FILED0 vactive size for all interlaced modes
except for SDI NTSC mode jsr 10/01/18 Removed the hard coded programming of
vactive size values based on resolutions. Moved the hard coded values for SDI
NTSC resolution to SDI TXSS driver instead of in VTC driver. jsr 10/03/18
Corrected the VGA resoultion timing paramters w.r.t the timing values given in
the VTC GUI for 640x480p </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vtc/src/xvtc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvtc.h @addtogroup vtc_v7_2 @{
@details This is the main header file of Xilinx MVI Video Timing Controller
(VTC) device driver. The VTC device detects video signals, independently
overrides any one of them, re-generates video signals with +/- delay and with
polarity inversion, and generates up to 16 one cycle Frame Sync outputs. The
device has the following main features: - Detect video signals: - horizontal
sync - horizontal blank - vertical sync - vertical blank - active video - field
id - Independently override any one signal. - Re-generate video signals with +/-
delay and with polarity inversion. - Generate up to 16 one cycle Frame Sync
outputs. For a full description of VTC features, please see the hardware
specification. <b>Software Initialization & Configuration</b> The application
needs to do following steps in order for preparing the VTC to be ready to
process video signal handling. - Call XVtc_LookupConfig using a device ID to
find the core configuration. - Call XVtc_CfgInitialize to initialize the device
and the driver instance associated with it. - Call XVtc_SetGenerator to set up
the video signals to generate, if desired. - Call XVtc_SetPolarity to set up the
video signal polarity. - Call XVtc_SetSource for source selection - Call
XVtc_SetGeneratorHoriOffset to set up the Generator VBlank/VSync horizontal
offsets, if values other than the default are needed - Call XVtc_EnableSync, if
generator needs to be synced to the detector - Call XVtc_Enable to enable/start
the VTC device. <b>Interrupts </b> The interrupt types supported are: - Frame
Sync Interrupts 0 - 15 - Generator interrupt: - Generator Active Video Interrupt
- Generator VBLANK Interrupt - Detector interrupt: - Detector Active Video
Interrupt - Detector VBLANK Interrupt - Signal Lock interrupt: - Active Chroma
signal lock - Active Video Signal Lock - Field ID Signal Lock - Vertical Blank
Signal Lock - Vertical Sync Signal Lock - Horizontal Blank Signal Lock -
Horizontal Sync Signal Lock <b> Virtual Memory </b> This driver supports Virtual
Memory. The RTOS is responsible for calculating the correct device base address
in Virtual Memory space. <b> Threads </b> This driver is not thread safe. Any
needs for threads or thread mutual exclusion must be satisfied by the layer
above this driver. <b> Asserts </b> Asserts are used within all Xilinx drivers
to enforce constraints on argument values. Asserts can be turned off on a
system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The Vtc driver is composed of
several source files. This allows the user to build and link only those parts of
the driver that are necessary. <b> Examples </b> An example is provided with
this driver to demonstrate the driver usage. <b>Cache Coherency</b>
<b>Alignment</b> <b>Limitations</b> <b>BUS Interface</b> <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a xd 08/05/08 First
release 1.01a xd 07/23/10 Added GIER Added more h/w generic info into
xparameters.h Feed callbacks with pending interrupt info. Added Doxygen &
Version support 2.00a xd 05/13/11 1. Renamed to "Video Timing Controller" 2.
Added Generator/Detector VBlank/VSync Horizontal offset setup/fetch support 3.
Renamed the IP to support to be axi_vtc 4. Supported sync between generator and
detector with addition of new XVtc_EnableSync and XVtc_DisableSync functions 5.
Renamed XVtc_SetSync to XVtc_SetFSync 6. Renamed XVtc_GetSync to XVtc_GetFSync
7. Removed unnecessary register write in XVtc_Reset 8. Corrected driver name in
.mdd file 9. Updated register bit definition (a few fields grow from 12 to 13
bit wide) 2.00a cm 05/25/11 1. Renamed XVtc_SetSkip to XVtc_SetSkipLine 2.
Renamed XVtc_GetSkip to XVtc_GetSkipLine 3. Added XVtc_SetSkipPixel 4. Added
XVtc_GetSkipPixel 2.00a cm 06/16/12 1. Added missing xil_assert.h include 2.00a
cm 07/25/12 1. Removed unused XVtc_IntrSetLockPolarity function 3.00a cm
08/02/12 1. Added the XVtc_Sync_Reset frame sync'ed SW reset function. 3.00a cjm
08/02/12 Converted from xio.h to xil_io.h, translating basic types, MB cache
functions, exceptions and assertions to xil_io format. Replaced the following
"XExc_Init" -> "Xil_ExceptionInit" "XExc_RegisterHandler" ->
"Xil_ExceptionRegister Handler" "XEXC_ID_NON_CRITICAL_INT" ->
"XIL_EXCEPTION_ID_INT" "XExceptionHandler" -> "Xil_ExceptionHandler"
"XExc_mEnableExceptions" -> "Xil_ExceptionEnable" "XEXC_NON_CRITICAL" ->
"XIL_EXCEPTION_NON_CRITICAL" "XExc_DisableExceptions" -> "Xil_ExceptionDisable"
"XExc_RemoveHandler" -> "Xil_ExceptionRemoveHandler"
"microblaze_enable_interrupts" -> "Xil_ExceptionEnable"
"microblaze_disable_interrupts" -> "Xil_Exception Disable"
"XCOMPONENT_IS_STARTED" -> "XIL_COMPONENT_IS_STARTED" "XCOMPONENT_IS_READY" ->
"XIL_COMPONENT_IS_READY" "XASSERT_NONVOID" -> "Xil_AssertNonvoid"
"XASSERT_VOID_ALWAYS" -> "Xil_AssertVoidAlways" "XASSERT_VOID" ->
"Xil_AssertVoid" "Xil_AssertVoid_ALWAYS" -> "Xil_AssertVoidAlways"
"XAssertStatus" -> "Xil_AssertStatus" "XAssertSetCallback" ->
"Xil_AssertCallback" "XASSERT_OCCURRED" -> "XIL_ASSERT_OCCURRED" "XASSERT_NONE"
-> "XIL_ASSERT_NONE" "microblaze_disable_dcache" -> "Xil_DCacheDisable"
"microblaze_enable_dcache" -> "Xil_DCacheEnable" "microblaze_enable_icache" ->
"Xil_ICacheEnable" "microblaze_disable_icache" -> "Xil_ICacheDisable"
"microblaze_init_dcache_range" -> "Xil_DCacheInvalidate Range"
"XCache_DisableDCache" -> "Xil_DCacheDisable" "XCache_DisableICache" ->
"Xil_ICacheDisable" "XCache_EnableDCache" -> "Xil_DCacheEnableRegion"
"XCache_EnableICache" -> "Xil_ICacheEnableRegion" "XCache_InvalidateDCacheLine"
-> "Xil_DCacheInvalidate Range" "XUtil_MemoryTest32" -> "Xil_TestMem32"
"XUtil_MemoryTest16" -> "Xil_TestMem16" "XUtil_MemoryTest8" -> "Xil_TestMem8"
"xutil.h" -> "xil_testmem.h" "xbasic_types.h" -> "xil_types.h" "xio.h" ->
"xil_io.h" "XIo_In32" -> "Xil_In32" "XIo_Out32" -> "Xil_Out32" "XTRUE" -> "TRUE"
"XFALSE" -> "FALSE" "XNULL" -> "NULL" "Xuint8" -> "u8" "Xuint16" -> "u16"
"Xuint32" -> "u32" "Xint8" -> "char" "Xint16" -> "short" "Xint32" -> "long"
"Xfloat32" -> "float" "Xfloat64" -> "double" "Xboolean" -> "int" "XTEST_FAILED"
-> "XST_FAILURE" "XTEST_PASSED" -> "XST_SUCCESS" 4.00a cjm 02/07/13 Removed
Unused Functions XVtc_IntrEnableGlobal XVtc_IntrDisableGlobal 5.00a cjm 08/07/13
Replaced XVTC_RESET with (XVTC_CTL) Replaced XVTC_RESET_RESET_MASK with
(XVTC_CTL_RESET_MASK) Replaced XVTC_SYNC_RESET_MASK with (XVTC_CTL_SRST_MASK)
5.00a cjm 10/30/13 Replaced XVtc_RegUpdate with XVtc_RegUpdateEnable Added
XVtc_RegUpdateDisable Removed type parameter from XVtc_Enable Added
XVtc_EnableGenerator to enable only the Generator Added XVtc_EnableDetector to
enable only the Detector 5.00a cjm 11/01/13 Added Timing, VideoMode and Signal
Conversion Functions: XVtc_ConvVideoMode2Timing XVtc_ConvTiming2Signal
XVtc_ConvSignal2Timing XVtc_ConvTiming2VideoMode Added Timing and Video Mode
Set/Get Functions: XVtc_SetGeneratorTiming XVtc_SetGeneratorVideoMode
XVtc_GetGeneratorTiming XVtc_GetGeneratorVideoMode XVtc_GetDetectorTiming
XVtc_GetDetectorVideoMode 6.0 adk 19/12/13 Updated as per the New Tcl API's. 6.1
adk 23/08/14 Implemented XVtc_SelfTest in xvtc_selftest.c. Modified prototype of
XVtc_GetVersion API. 7.0 vns 02/25/15 Added Interlaced field to XVtc_Signal
structure, Removed XVtc_RegUpdate as there are is one more API,
XVtc_RegUpdateEnable with same functionality but provided backward
compatability. Modifications from xvtc.c file are: Modified HActiveVideo value
to 1920 for XVTC_VMODE_1080I mode. Removed Major, Minor and Revision parameters
from XVtc_GetVersion. Modified return type of XVtc_GetVersion from void to u32.
Added progressive and interlaced mode switching feature. Modified
XVtc_SetGenerator, XVtc_GetGenerator, XVtc_GetDetector, XVtc_ConvTiming2Signal
and XVtc_ConvSignal2Timing APIs Modifications from xvtc_hw.h file are: Removed
XVTC_ERR_FIL_MASK macro because it is not present in latest product guide.
Modified register offsets from XVTC_ to XVTC__OFFSET for consistency. Added
backward compatibility macros. Modifications from xvtc_intr.c and xvtc_sinit.c
files are: updated doxygen tags. Modifications from xvtc_selftest.c file are:
First Release. Implemented following function: XVtc_SelfTest. 7.1 vns 10/14/15
Added InterlacedMode feild to XVtc_SourceSelect structure 7.2 sk 08/16/16 Used
UINTPTR instead of u32 for Baseaddress as part of adding 64 bit support. CR
867425. Changed the prototype of XVtc_CfgInitialize API. ms 03/17/17 Added
readme.txt file in examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/vtc/src/xvtc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvtc_hw.h @addtogroup vtc_v7_2
@{ This header file contains identifiers and register-level core functions (or
macros) that can be used to access the Xilinx VTC core. For more information
about the operation of this core, see the hardware specification and
documentation in the higher level driver xvtc.h source code file. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a xd
08/05/08 First release. 1.01a xd 07/23/10 Added GIER. Added more h/w generic
info into xparameters.h. Feed callbacks with pending interrupt info. Added
Doxygen & Version support. 2.00a cm 05/25/11 Renamed XVTC_CTL_GACS_MASK to
XVTC_CTL_GACLS_MASKl. Added XVTC_CTL_GACPS_MASK. 3.00a cjm 08/01/12 Converted
from xio.h to xil_io.h, translating basic types, MB cache functions, exceptions
and assertions to xil_io format. Replaced the following "XExc_Init" ->
"Xil_ExceptionInit" "XExc_RegisterHandler" -> "Xil_ExceptionRegisterHandler"
"XEXC_ID_NON_CRITICAL_INT" -> "XIL_EXCEPTION_ID_INT" "XExceptionHandler" ->
"Xil_ExceptionHandler" "XExc_mEnableExceptions" -> "Xil_ExceptionEnable"
"XEXC_NON_CRITICAL" -> "XIL_EXCEPTION_NON_CRITICAL" "XExc_DisableExceptions" ->
"Xil_ExceptionDisable" "XExc_RemoveHandler" -> "Xil_ExceptionRemoveHandler"
"microblaze_enable_interrupts" -> "Xil_Exception Enable"
"microblaze_disable_interrupts" -> "Xil_Exception Disable"
"XCOMPONENT_IS_STARTED" -> "XIL_COMPONENT_IS_STARTED" "XCOMPONENT_IS_READY" ->
"XIL_COMPONENT_IS_READY" "XASSERT_NONVOID" -> "Xil_AssertNonvoid"
"XASSERT_VOID_ALWAYS" -> "Xil_AssertVoidAlways" "XASSERT_VOID" ->
"Xil_AssertVoid" "Xil_AssertVoid_ALWAYS" -> "Xil_AssertVoidAlways"
"XAssertStatus" -> "Xil_AssertStatus" "XAssertSetCallback" ->
"Xil_AssertCallback" "XASSERT_OCCURRED" -> "XIL_ASSERT_OCCURRED" "XASSERT_NONE"
-> "XIL_ASSERT_NONE" "microblaze_disable_dcache" -> "Xil_DCacheDisable"
"microblaze_enable_dcache" -> "Xil_DCacheEnable" "microblaze_enable_icache" ->
"Xil_ICacheEnable" "microblaze_disable_icache" -> "Xil_ICacheDisable"
"microblaze_init_dcache_range" -> "Xil_DCache InvalidateRange"
"XCache_DisableDCache" -> "Xil_DCacheDisable" "XCache_DisableICache" ->
"Xil_ICacheDisable" "XCache_EnableDCache" -> "Xil_DCacheEnableRegion"
"XCache_EnableICache" -> "Xil_ICacheEnableRegion" "XCache_InvalidateDCacheLine"
-> "Xil_DCache InvalidateRange" "XUtil_MemoryTest32" -> "Xil_TestMem32"
"XUtil_MemoryTest16" -> "Xil_TestMem16" "XUtil_MemoryTest8" -> "Xil_TestMem8"
"xutil.h" -> "xil_testmem.h" "xbasic_types.h" -> "xil_types.h" "xio.h" ->
"xil_io.h" "XIo_In32" -> "Xil_In32" "XIo_Out32" -> "Xil_Out32" "XTRUE" -> "TRUE"
"XFALSE" -> "FALSE" "XNULL" -> "NULL" "Xuint8" -> "u8" "Xuint16" -> "u16"
"Xuint32" -> "u32" "Xint8" -> "char" "Xint16" -> "short" "Xint32" -> "long"
"Xfloat32" -> "float" "Xfloat64" -> "double" "Xboolean" -> "int" "XTEST_FAILED"
-> "XST_FAILURE" "XTEST_PASSED" -> "XST_SUCCESS" 3.00a cjm 08/02/12 Changed
XVTC_RESET_RESET_MASK from 0x0000_000a to 0x8000_0000 4.00a cjm 02/07/13 Remove
Unused defines: XVTC_GIER, XVTC_GIER_GIE_MASK. 4.00a cjm 02/08/13 Removed
XVTC_CTL_HASS_MASK. 5.00a cjm 08/06/13 Replaced CTL in Polarity and Encoding
register definition with "POL" and "ENC". Renamed XVTC_RESET_RESET_MASK to
XVTC_CTL_RESET_MASK. Renamed XVTC_SYNC_RESET_MASK to XVTC_CTL_SRST_MASK. Renamed
Error register bit defs to XVTC_ERR_ Added Patch and Internal Revision MASKs
for. Revision register. 5.00a cjm 11/01/13 Removed Unused Hori Offset registers
defines from 0x0a0 - 0x0c0A Added interlaced register defines. Changed Version
Register Revision shift from 12 to 8 and changed mask to be 8 instead of 4 bits
wide 5.00a cjm 11/03/13 Added Chroma/field parity bit masks. Replaced old timing
bit masks/shifts with Start/End Bit masks/shifts. 6.1 adk 08/23/14 Removed
XVTC_ERR_FIL_MASK macro because it is not present in latest product guide.
Modified register offsets from XVTC_ to XVTC__OFFSET for consistency. Added
backward compatibility macros. 7.1 vns 10/14/15 Added XVTC_CTL_INTERLACE_MASK
macro and modified XVTC_CTL_ALLSS_MASK 8.0 jsr 07/03/18 Added new register
XVTC_GASIZE_F1_OFFSET </pre>

FILES:
XilinxProcessorIPLib/drivers/vtc/src/xvtc_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvtc_intr.c @addtogroup
vtc_v7_2 @{ This file contains interrupt related functions of Xilinx VTC core.
Please see xvtc.h for more details of the core. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ------ -------- 1.00a xd 08/05/08 First release 1.01a xd
07/23/10 Added GIER. Added more h/w generic info into xparameters.h. Feed
callbacks with pending interrupt info. Added Doxygen & Version support. 3.00a
cjm 08/01/12 Converted from xio.h to xil_io.h, translating basic types, MB cache
functions, exceptions and assertions to xil_io format. Replaced the following:
"XExc_Init" -> "Xil_ExceptionInit" "XExc_RegisterHandler" -> "Xil_Exception
RegisterHandler" "XEXC_ID_NON_CRITICAL_INT" -> "XIL_EXCEPTION_ID_INT"
"XExceptionHandler" -> "Xil_ExceptionHandler" "XExc_mEnableExceptions" ->
"Xil_ExceptionEnable" "XEXC_NON_CRITICAL" -> "XIL_EXCEPTION_NON_CRITICAL"
"XExc_DisableExceptions" -> "Xil_ExceptionDisable" "XExc_RemoveHandler" ->
"Xil_ExceptionRemoveHandler" "microblaze_enable_interrupts" -> "Xil_Exception
Enable" "microblaze_disable_interrupts" -> "Xil_Exception Disable"
"XCOMPONENT_IS_STARTED" -> "XIL_COMPONENT_IS_STARTED" "XCOMPONENT_IS_READY" ->
"XIL_COMPONENT_IS_READY" "XASSERT_NONVOID" -> "Xil_AssertNonvoid"
"XASSERT_VOID_ALWAYS" -> "Xil_AssertVoidAlways" "XASSERT_VOID" ->
"Xil_AssertVoid" "Xil_AssertVoid_ALWAYS" -> "Xil_AssertVoidAlways"
"XAssertStatus" -> "Xil_AssertStatus" "XAssertSetCallback" ->
"Xil_AssertCallback" "XASSERT_OCCURRED" -> "XIL_ASSERT_OCCURRED" "XASSERT_NONE"
-> "XIL_ASSERT_NONE" "microblaze_disable_dcache" -> "Xil_DCacheDisable"
"microblaze_enable_dcache" -> "Xil_DCacheEnable" "microblaze_enable_icache" ->
"Xil_ICacheEnable" "microblaze_disable_icache" -> "Xil_ICacheDisable"
"microblaze_init_dcache_range" -> "Xil_DCache InvalidateRange"
"XCache_DisableDCache" -> "Xil_DCacheDisable" "XCache_DisableICache" ->
"Xil_ICacheDisable" "XCache_EnableDCache" -> "Xil_DCacheEnableRegion"
"XCache_EnableICache" -> "Xil_ICacheEnableRegion" "XCache_InvalidateDCacheLine"
-> "Xil_DCache InvalidateRange" "XUtil_MemoryTest32" -> "Xil_TestMem32"
"XUtil_MemoryTest16" -> "Xil_TestMem16" "XUtil_MemoryTest8" -> "Xil_TestMem8"
"xutil.h" -> "xil_testmem.h" "xbasic_types.h" -> "xil_types.h" "xio.h" ->
"xil_io.h" "XIo_In32" -> "Xil_In32" "XIo_Out32" -> "Xil_Out32" "XTRUE" -> "TRUE"
"XFALSE" -> "FALSE" "XNULL" -> "NULL" "Xuint8" -> "u8" "Xuint16" -> "u16"
"Xuint32" -> "u32" "Xint8" -> "char" "Xint16" -> "short" "Xint32" -> "long"
"Xfloat32" -> "float" "Xfloat64" -> "double" "Xboolean" -> "int" "XTEST_FAILED"
-> "XST_FAILURE" "XTEST_PASSED" -> "XST_SUCCESS" 6.1 adk 08/23/14 Alligned
doxygen tags. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vtc/src/xvtc_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvtc_selftest.c @addtogroup
vtc_v7_2 @{ This file contains the self test function for the VTC core. The self
test function reads the Version register. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 6.1 adk 08/23/14 First Release. Implemented
following function: XVtc_SelfTest. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vtc/src/xvtc_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xvtc_sinit.c @addtogroup
vtc_v7_2 @{ This file contains static initialization methods for Xilinx VTC
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00a xd 08/05/08 First release. 1.01a xd 07/23/10 Added GIER; Added more h/w
generic info into xparameters.h. Feed callbacks with pending interrupt info.
Added Doxygen & Version support. 3.00a cjm 08/01/12 Converted from xio.h to
xil_io.h, translating basic types, MB cache functions, exceptions and assertions
to xil_io format. Replaced the following: "Xuint16" -> "u16". 6.1 adk 08/23/14
updated doxygen tags. 7.1 als 08/11/16 Provide protection against driver
inclusion in the absence of VTC instantiation. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/vtc/src/xvtc_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps_intr_example.c This file
contains a design example using the System Watchdog Timer Device (WdtPs) driver
and hardware device using interrupt mode. This test assumes that the RESET
OUTPUT OF WDT IS NOT CONNECTED to the processor and the IRQ output is connected
to an interrupt controller attached to the processor @note <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a ecm/jz 01/15/10 First
release 3.1 sg 08/20/18 Updated interrupt example to fix interrupt ID conflict
issue </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdtps/examples/xwdtps_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps_polled_example.c This
file contains a design example using the System Watchdog Timer driver (XWdtPs)
and hardware device. This function assumes that the reset output of the Watchdog
timer device is not connected to the reset of the processor. @note None.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 1.00a
ecm/jz 01/15/10 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdtps/examples/xwdtps_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps_selftest_example.c This
file contains a design example using the System Watchdog Timer driver (XWdtPs)
and hardware device. @note None. MODIFICATION HISTORY: <pre> Ver Who Date
Changes ----- ------ -------- 1.00a sdm 05/27/11 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/wdtps/examples/xwdtps_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps.c @addtogroup wdtps_v3_1
@{ Contains the implementation of interface functions of the XWdtPs driver. See
xwdtps.h for a description of the driver. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 1.00a ecm/jz 01/15/10 First release 1.02a sg
07/15/12 Removed code/APIs related to External Signal Length functionality for
CR 658287 Removed APIs XWdtPs_SetExternalSignalLength,
XWdtPs_GetExternalSignalLength 3.00 kvn 02/13/15 Modified code for MISRA-C:2012
compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdtps/src/xwdtps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps.h @addtogroup wdtps_v3_1
@{ @details The Xilinx watchdog timer driver supports the Xilinx watchdog timer
hardware. The Xilinx watchdog timer (WDT) driver supports the following
features: - Both Interrupt driven and Polled mode - enabling and disabling the
watchdog timer - restarting the watchdog. - initializing the most significant
digit of the counter restart value. - multiple individually enabling/disabling
outputs It is the responsibility of the application to provide an interrupt
handler for the watchdog timer and connect it to the interrupt system if
interrupt driven mode is desired. If interrupt is enabled, the watchdog timer
device generates an interrupt when the counter reaches zero. If the hardware
interrupt signal is not connected/enabled, polled mode is the only option (using
IsWdtExpired) for the watchdog. The outputs from the WDT are individually
enabled/disabled using _EnableOutput()/_DisableOutput(). The clock divisor ratio
and initial restart value of the count is configurable using
_SetControlValues(). The reset condition of the hardware has the maximum initial
count in the Counter Reset Value (CRV) and the WDT is disabled with the reset
enable enabled and the reset length set to 32 clocks. i.e. <pre> register ZMR
0x1C2 register CCR 0x3FC </pre> This driver is intended to be RTOS and processor
independent. It works with physical addresses only. Any needs for dynamic memory
management, threads or thread mutual exclusion, virtual memory, or cache control
must be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.00a ecm/jz 01/15/10 First release
1.01a asa 02/15/12 Added tcl file to generate xparameters 1.02a sg 07/15/12
Removed code/APIs related to External Signal Length functionality for CR 658287
Removed APIs XWdtPs_SetExternalSignalLength, XWdtPs_GetExternalSignalLength
Modified the Self Test to use the Reset Length mask for CR 658287 3.0 pkp
12/09/14 Added support for Zynq Ultrascale Mp.Also modified code for
MISRA-C:2012 compliance. ms 03/17/17 Added readme.txt file in examples folder
for doxygen generation. 3.1 sg 08/17/18 Updated interrupt example to fix
interrupt ID conflict issue </pre>

FILES:
XilinxProcessorIPLib/drivers/wdtps/src/xwdtps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps_g.c @addtogroup
wdtps_v3_1 @{ This file contains a table that specifies the configuration of the
watchdog timer devices in the system. Each device should have an entry in the
table. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.00a ecm/jz 01/15/10 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdtps/src/xwdtps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps_hw.h @addtogroup
wdtps_v3_1 @{ This file contains the hardware interface to the System Watch Dog
Timer (WDT). <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a ecm/jz 01/15/10 First release 1.02a sg 07/15/12 Removed defines
related to External Signal Length functionality for CR 658287 3.00 kvn 02/13/15
Modified code for MISRA-C:2012 compliance. </pre>

FILES:
XilinxProcessorIPLib/drivers/wdtps/src/xwdtps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps_selftest.c @addtogroup
wdtps_v3_1 @{ Contains diagnostic self-test functions for the XWdtPs driver.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a
ecm/jz 01/15/10 First release 1.02a sg 08/01/12 Modified it use the Reset Length
mask for the self test for CR 658287 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdtps/src/xwdtps_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdtps_sinit.c @addtogroup
wdtps_v3_1 @{ This file contains method for static initialization (compile-time)
of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a ecm/jz 01/15/10 First release 3.00 kvn 02/13/15 Modified code for
MISRA-C:2012 compliance. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdtps/src/xwdtps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 10/12/13 Removed support for
xps_timebase_wdt 4.0 sha 12/17/15 Added Window WDT feature with basic mode. 4.3
srm 01/27/18 Added support to program the width of WDT 4.4 aru 11/15/18 Fixed
compiler warning 4.4 sne 03/04/19 Added versal support. 4.5 mus 04/10/19 Support
hierarchical designs. Fix for CR1020269 @BEGIN_CHANGELOG EDK_M 12/04/09 ktn
removed support for opb_timebase_wdt @END_CHANGELOG @BEGIN_CHANGELOG EDK_MS3
06/16/10 sv Added support for axi_timebase_wdt @END_CHANGELOG

FILES:
XilinxProcessorIPLib/drivers/wdttb/data/wdttb.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 2.0 adk 12/10/13 Updated as per the New Tcl
API's 4.0 sha 12/17/15 Updated the driver tcl to support parameters for legacy
and window WDT. 4.2 ms 04/18/17 Modified tcl file to add suffix U for all macros
definitions of wdttb in xparameters.h 4.4 sne 03/04/19 Added versal support. 4.5
mus 04/10/19 Added -hier option to get_cells command to support hierarchical
designs. Fix for CR1020269. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/wdttb/data/wdttb.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file wdttb_header.h This header file
contains the include files used to run the TestApp of the Watchdog Timer. @note
None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 2.00a
ktn 10/22/09 Updated to use the HAL processor APIs/macros. </pre>

FILES:
XilinxProcessorIPLib/drivers/wdttb/data/wdttb_header.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file wdttb_intr_header.h This header
file contains the include files used to run the TestApp of the Watchdog Timer.
@note None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
2.00a ktn 10/22/09 Updated to use the HAL processor APIs/macros. </pre>

FILES:
XilinxProcessorIPLib/drivers/wdttb/data/wdttb_intr_header.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes -------- ------ -------- 3.0 adk 12/10/13 Updated as per the New Tcl
API's @BEGIN_CHANGELOG EDK_Im_SP2 - Added Interrupt support @END_CHANGELOG
@BEGIN_CHANGELOG EDK_I - include header files @END_CHANGELOG @BEGIN_CHANGELOG
EDK_H - Added support for generation of multiple applications. All TCL
procedures are now required to have a software project type as its first
argument @END_CHANGELOG Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project
Types (swproj): 0 : MemoryTest - Calls basic memorytest routines from common
driver dir 1 : PeripheralTest - Calls any existing polled_example and/or
selftest TCL Procedures:

FILES:
XilinxProcessorIPLib/drivers/wdttb/data/wdttb_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_example.c This file
contains a design example using the Watchdog Timer Timebase driver (XWdtTb) and
hardware device. @note None. MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 1.00b jhl 02/13/02 First release 1.00b sv 04/26/05 Minor
changes to comply to Doxygen and coding guidelines 2.00a ktn 12/02/09 Updated
the example to use the HAL APIs/macros. Updated this example to check for
Watchdog timer reset condition instead of timer expiry state to avoid a race
condition 4.0 sha 02/04/16 Added debug messages. Updated
WatchdogTimebase.RegBaseAddress -> WatchdogTimebase.Config.BaseAddr. Calling
XWdtTb_LookupConfig and XWdtTb_CfgInitialize functions instead of
XWdtTb_Initialize for initialization. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_gwdt_example.c This file
contains a example for using the Generic Watchdog Timer hardware and driver
@note None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 sne 03/04/19 Initial release for Generic Watchdog Timer. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_gwdt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_gwdt_selftest_example.c
This file contains an example for using the Generic Watchdog Timer hardware and
driver @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 sne 02/04/19 Initial release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_gwdt_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_intr_example.c This file
contains a design example using the TimeBase Watchdog Timer Device (WdtTb)
driver and hardware device using interrupt mode (for the WDT interrupt). @note
This example assumes that the reset output of the WdtTb device is not connected
to the reset of the processor. This example will not return if the interrupts
are not working. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00b hvm 05/10/06 First release 1.00b sv 05/30/06 Updated to support
interrupt examples in Test App 1.11a hvm 03/30/09 Modified the example to avoid
a race condition 2.00a ktn 10/22/09 Updated the example to use the HAL
APIs/macros. Updated the example with support for MicroBlaze. 2.00a ssb 01/11/01
Updated the example to be used with the SCUGIC in Zynq. 4.0 sha 02/04/16 Added
debug messages. Updated WdtTbInstancePtr->RegBaseAddress ->
WdtTbInstancePtr->Config.BaseAddr. Calling XWdtTb_LookupConfig and
XWdtTb_CfgInitialize functions instead of XWdtTb_Initialize for initialization.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_low_level_example.c This
file contains a design example using the low-level driver macros of the Watchdog
Timer Timebase driver. These macros are found in xwdttb_l.h. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b rpm
04/26/02 First release 1.00b sv 04/26/05 Minor changes to comply to Doxygen and
coding guidelines 2.00a ktn 22/10/09 Updated the example to use the HAL
APIs/macros. The following macros defined in xwdttb_l.h file have been removed -
XWdtTb_mEnableWdt, XWdtTb_mDisbleWdt, XWdtTb_mRestartWdt, XWdtTb_mGetTimebaseReg
and XWdtTb_mHasReset. The example is updated to use XWdtTb_ReadReg and
XWdtTb_WriteReg macros to achieve the functionality of the macros that were
removed. Updated this example to check for Watchdog timer reset condition
instead of timer expiry state to avoid a race condition 4.0 sha 02/04/16 Added
debug messages. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_low_level_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_selftest_example.c This
file contains a example for using the Watchdog Timer Timebase hardware and
driver @note None <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sv 04/27/05 Initial release for TestApp integration. 2.00a ktn
22/10/09 Updated the example to use the HAL APIs/macros. 4.0 sha 02/04/16 Added
debug messages. Calling XWdtTb_LookupConfig and XWdtTb_CfgInitialize functions
instead of XWdtTb_Initialize for initialization. 4.4 sne 02/12/19 Added support
for Versal </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_winwdt_example.c This
file contains a design example using the Watchdog Timer Timebase (XWdtTb) driver
with window feature. The WDTTB core will be generated either in legacy or window
feature. @note None MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ----
-------- 4.0 sha 02/04/16 First release. 4.4 sne 03/04/19 Added support for
Versal. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_winwdt_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_winwdt_intr_example.c
This file contains a design example using the TimeBase Watchdog Timer Device
(WdtTb) driver and hardware device using interrupt mode (for the WDT interrupt).
@note This example assumes that the reset output of the WdtTb device is not
connected to the reset of the processor. This example will not return if the
interrupts are not working. MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 4.0 sha 02/04/16 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/examples/xwdttb_winwdt_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb.c @addtogroup wdttb_v4_4
@{ Contains the required functions of the XWdtTb driver. See xwdttb.h for a
description of the driver. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a ecm 08/16/01 First release 1.00b jhl 02/21/02
Repartitioned the driver for smaller files 1.00b rpm 04/26/02 Made LookupConfig
public 1.10b mta 03/23/07 Updated to new coding style 2.00a ktn 10/22/09 Updated
to use the HAL processor APIs/macros. 4.0 sha 12/17/15 Added Window WDT feature
with basic mode. Moved XWdtTb_LookupConfig definition to xwdttb_sinit.c.
Adherence to coding and Doxygen guidelines. Removed included xil_io, xil_types,
xparameters and xil_assert header files. Moved XWdtTb_GetTbValue to xwdttb.h
file. Adherence to MISRA-C guidelines. 4.0 sha 01/29/16 Added functions for
Window WDT feature: XWdtTb_AlwaysEnable, XWdtTb_ClearLastEvent,
XWdtTb_ClearResetPending, XWdtTb_IntrClear, XWdtTb_SetByteCount,
XWdtTb_GetByteCount, XWdtTb_SetByteSegment, XWdtTb_GetByteSegment,
XWdtTb_EnableSst, XWdtTb_DisableSst, XWdtTb_EnablePsm, XWdtTb_DisablePsm,
XWdtTb_EnableFailCounter, XWdtTb_DisableFailCounter,
XWdtTb_EnableExtraProtection, XWdtTb_DisableExtraProtection,
XWdtTb_SetWindowCount, XWdtTb_EnableWinWdt, XWdtTb_DisableWinWdt,
XWdtTb_CfgInitialize. Updated functions with Window WDT feature: XWdtTb_Start,
XWdtTb_Stop, XWdtTb_IsWdtExpired, XWdtTb_RestartWdt. Modified lines with
exceeding maximum 80 chars. Changed multi line comments to single line comments
wherever required. 4.3 srm 01/27/18 Added XWdtTb_ProgramWDTWidth which can
program the width of WDT 01/30/18 Added doxygen tags 4.4 aru 11/15/18 Replaced
"Xil_AssertVoid" as "Xil_AssertNonvoid" in XWdtTb_ProgramWDTWidth(). 4.4 sne
02/28/19 Added Static functions for Window WDT feature:
XWdtTb_EnableTiWdt,XWdtTb_DisableTiWdt. 4.4 sne 03/01/19 Fixed violations
according to MISRAC-2012 standards modified the code for below violations, No
brackets to then/else, Literal value requires a U suffix,Function return type
inconsistent,Logical conjunctions need brackets, Declared the pointer param as
Pointer to const, Procedure has more than one exit point. 4.4 sne 03/04/19 Added
support for Versal( Generic Watchdog and Window Watchdog Timer). Added below
functions: XWdtTb_EnableGenericWdt,XWdtTb_DisableGenericWdt,
XWdtTb_EnableTimebaseWdt,XWdtTb_DisableTimebaseWdt,
XWdtTb_IsGenericWdtFWExpired,XWdtTb_SetGenericWdtWindow. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/src/xwdttb.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb.h @addtogroup wdttb_v4_4
@{ @details The Xilinx watchdog timer/timebase component supports the Xilinx
legacy watchdog timer/timebase and window watchdog timer hardware. More detailed
description of the driver operation for each function can be found in the
xwdttb.c file. The Xilinx watchdog timer/timebase driver supports both legacy
and window features: Features in legacy watchdog timer: - Polled mode - enabling
and disabling (if allowed by the hardware) the watchdog timer - restarting the
watchdog. - reading the timebase. Features in window watchdog timer: -
Configurable close and open window periods. - Enabling and disabling Fail
Counter (FC). - Enabling and disabling Program Sequence Monitor (PSM). -
Enabling and disabling Second Sequence Timer (SST). - Setting interrupt
assertion point in second window. - Controlling the write access to the complete
address space. - Always enable. The window watchdog timer always enable feature
enables watchdog timer forever. It can only be disabled by applying the reset to
the processor or core. It is the responsibility of the application to provide an
interrupt handler for the timebase and the watchdog and connect them to the
interrupt system if interrupt driven mode is desired. The legacy watchdog
timer/timebase component ALWAYS generates an interrupt output when: - the
watchdog expires the first time - the timebase rolls over and ALWAYS generates a
reset output when the watchdog timer expires a second time. This is not
configurable in any way from the software driver's perspective. The window
watchdog timer asserts an interrupt when - the watchdog reaches at the interrupt
programmed point in second window and ALWAYS generates reset output - when
single bad event occur if fail count disable, - if fail counter is 7 and bad
event happens. The Timebase is reset to 0 when the Watchdog Timer is enabled. If
the hardware interrupt signal is not connected, polled mode is the only option
(using IsWdtExpired) for the legacy watchdog and GetIntrStatus option for the
window watchdog. Reset output will occur for the second watchdog timeout
regardless. Polled mode for the timebase rollover is just reading the contents
of the register and seeing if the MSB has transitioned from 1 to 0. The
IsWdtExpired function is used for polling the watchdog timebase timer and it is
also used to check if the watchdog was the cause of the last reset. In this
situation, call Initialize then call IsWdtExpired. If the result is true
watchdog timeout caused the last system reset. It is then acceptable to further
initialize the component which will reset this bit. The XWdtTb_GetIntrStatus is
used for polling the window watchdog timer and it is used to check if interrupt
programmed point has reached. This driver is intended to be RTOS and processor
independent. It works with physical addresses only. Any needs for dynamic memory
management, threads or thread mutual exclusion, virtual memory, or cache control
must be satisfied by the layer above this driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a ecm 08/16/01 First release 1.00b
jhl 02/21/02 Repartitioned driver for smaller files 1.00b rpm 04/26/02 Made
LookupConfig public and added XWdtTb_Config 1.10b mta 03/23/07 Updated to new
coding style 1.11a sdm 08/22/08 Removed support for static interrupt handlers
from the MDD file 2.00a ktn 22/10/09 The driver is updated to use HAL processor
APIs/macros. The following macros defined in xwdttb_l.h file have been removed -
XWdtTb_mEnableWdt, XWdtTb_mDisbleWdt, XWdtTb_mRestartWdt, XWdtTb_mGetTimebaseReg
and XWdtTb_mHasReset. Added the XWdtTb_ReadReg and XWdtTb_WriteReg macros. User
should XWdtTb_ReadReg/XWdtTb_WriteReg to achieve the desired functionality of
the macros that were removed. 3.0 adk 19/12/13 Updated as per the New Tcl API's
3.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR 867425. 4.0 sha
12/17/15 Added Window WDT feature with basic mode. Changed XWdtTb_GetTbValue to
inline function. Adherence to MISRA-C guidelines. 4.0 sha 01/29/16 Added
XWdtTb_Event enum type. Updated XWdtTb_Config structure with Window WDT
parameters. Updated XWdtTb core structure with config parameter and removed
RegBaseAddress parameter. Added following static inline functions:
XWdtTb_GetTbValue, XWdtTb_SetRegSpaceAccessMode, XWdtTb_GetRegSpaceAccessMode,
XWdtTb_GetLastEvent, XWdtTb_GetFailCounter, XWdtTb_IsResetPending,
XWdtTb_GetIntrStatus, XWdtTb_IsWrongCfg. Added following functions:
XWdtTb_AlwaysEnable, XWdtTb_ClearLastEvent, XWdtTb_ClearResetPending,
XWdtTb_IntrClear, XWdtTb_SetByteCount, XWdtTb_GetByteCount,
XWdtTb_SetByteSegment, XWdtTb_GetByteSegment, XWdtTb_EnableSst,
XWdtTb_DisableSst, XWdtTb_EnablePsm, XWdtTb_DisablePsm,
XWdtTb_EnableFailCounter, XWdtTb_DisableFailCounter,
XWdtTb_EnableExtraProtection, XWdtTb_DisableExtraProtection,
XWdtTb_SetWindowCount, XWdtTb_CfgInitialize. 4.0 sha 02/17/16 Removed 3.1
version and added CR 867425 change in 4.0 version. 4.1 adk 23/12/16 Fix race
conition in the tcl CR966068 ms 03/17/17 Added readme.txt file in examples
folder for doxygen generation. 4.2 ms 04/18/17 Modified tcl file to add suffix U
for all macros definitions of wdttb in xparameters.h 4.3 srm 01/27/18 Added
XWdtTb_ProgramWDTWidth to pragram the WDT width 01/30/18 Added doxygen tags 4.4
aru 11/15/18 Replaced "Xil_AssertVoid" as "Xil_AssertNonvoid" in
XWdtTb_ProgramWDTWidth(). 4.4 sne 03/01/19 Fixed violations according to
MISRAC-2012 standards modified the code for below violations, No brackets to
then/else, Literal value requires a U suffix,Function return type
inconsistent,Logical conjunctions need brackets, Declared the pointer param as
Pointer to const, Procedure has more than one exit point. 4.4 sne 03/04/19 Added
support for Versal ( Generic Watchdog and Window Watchdog timer). Added
following functions: XWdtTb_IsGenericWdtFWExpired, XWdtTb_SetSSTWindow
XWdtTb_SetGenericWdtWindow. </pre>

FILES:
XilinxProcessorIPLib/drivers/wdttb/src/xwdttb.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_g.c @addtogroup
wdttb_v4_4 @{ Contains the required functions of the XWdtTb driver. See xwdttb.h
for a description of the driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a ecm 08/16/01 First release 4.3 srm 01/30/18
Added doxygen tags 4.4 sne 03/04/19 Added support for versal </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/src/xwdttb_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_hw.h @addtogroup
wdttb_v4_4 @{ This header file contains identifiers and register-level core
functions (or macros) that can be used to access the AXI Timebase and Window
Watchdog Timer core. For more information about the operation of this core see
the hardware specification and documentation in the higher level driver xwdttb.h
file. <pre> MODIFICATION HISTORY: Ver Who Date Changes ---- --- -------- 1.00
sha 12/17/15 First release. 4.0 sha 01/29/16 Updated version to 4.0 as it is
newly added file in driver version 4.0. Added following macros for Window WDT:
XWT_MWR_OFFSET, XWT_ESR_OFFSET, XWT_FCR_OFFSET, XWT_FWR_OFFSET, XWT_SWR_OFFSET,
XWT_TSR0_OFFSET, XWT_TSR1_OFFSET, XWT_STR_OFFSET. Added following masks and
shifts macros for Window WDT: XWT_MWR_AEN_MASK, XWT_MWR_MWC_MASK,
XWT_ESR_LBE_MASK, XWT_ESR_FCV_MASK, XWT_ESR_WRP_MASK, XWT_ESR_WINT_MASK,
XWT_ESR_WSW_MASK, XWT_ESR_WCFG_MASK, XWT_ESR_WEN_MASK, XWT_FCR_SBC_MASK,
XWT_FCR_BSS_MASK, XWT_FCR_SSTE_MASK, XWT_FCR_PSME_MASK, XWT_FCR_FCE_MASK,
XWT_FCR_WM_MASK, XWT_FCR_WDP_MASK. XWT_ESR_LBE_SHIFT, XWT_ESR_FCV_SHIFT,
XWT_ESR_WRP_SHIFT, XWT_ESR_WINT_SHIFT, XWT_ESR_WSW_SHIFT, XWT_ESR_WCFG_SHIFT,
XWT_FCR_SBC_SHIFT, XWT_FCR_BSS_SHIFT, XWT_FCR_SSTE_SHIFT, XWT_FCR_WM_SHIFT. 4.3
srm 01/30/18 Added doxygen tags 4.4 sne 03/04/19 Added Support for Versal
(Generic Watchdog and Window Watchdog Timer). Added following macros for Generic
WDT: XWT_TFR_OFFSET,XWT_TRR_OFFSET,XWT_IENR_OFFSET,
XWT_IDR_OFFSET,XWT_IMR_OFFSET,XWT_GWRR_OFFSET,
XWT_GWCSR_OFFSET,XWT_GWOR_OFFSET,XWT_GWCVR0_OFFSET,
XWT_GWCVR1_OFFSET,XWT_GW_WR_OFFSET,XWT_GWCSR_GWEN_MASK,
XWT_GWCSR_GWS1_MASK,XWT_GWCSR_GWS2_MASK,XWT_GWCSR_MASK,
XWT_GW_WR_MASK,XWT_GWRR_MASK. Added following macro for Win WDT:
XWT_SSTWR_OFFSET. </pre>

FILES:
XilinxProcessorIPLib/drivers/wdttb/src/xwdttb_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_l.h @addtogroup
wdttb_v4_4 @{ This header file contains identifiers and basic driver functions
(or macros) that can be used to access the device. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00b rpm 04/26/02 First release 1.10b
mta 03/23/07 Updated to new coding style 2.00a ktn 22/10/09 The following macros
defined in this file have been removed XWdtTb_mEnableWdt, XWdtTb_mDisbleWdt,
XWdtTb_mRestartWdt XWdtTb_mGetTimebaseReg and XWdtTb_mHasReset. Added the
XWdtTb_ReadReg and XWdtTb_WriteReg macros. User should
XWdtTb_ReadReg/XWdtTb_WriteReg to achieve the desired functionality of the
macros that were removed. 4.0 sha 12/17/15 Added Window WDT feature with basic
mode. Removed extra include files. Moved constant and macro definitions to
xwdttb_hw.h file. 4.3 srm 01/30/18 Added doxygen tags </pre>

FILES:
XilinxProcessorIPLib/drivers/wdttb/src/xwdttb_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_selftest.c @addtogroup
wdttb_v4_4 @{ Contains diagnostic self-test functions for the XWdtTb component.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b jhl
02/06/02 First release 1.10b mta 03/23/07 Updated to new coding style 2.00a ktn
10/22/09 Updated to use the HAL processor APIs/macros. 4.0 sha 12/17/15
Adherence to coding and Doxygen guidelines. Changed int -> u32. Update self-test
with window WDT feature. Removed included xil_types, xil_io and xil_assert
header files. Adherence to MISRA-C guidelines. 4.0 sha 01/29/16 Added following
macros for Window WDT feature: XWT_FW_COUNT, XWT_SW_COUNT. 4.3 srm 01/30/18
Added doxygen tags 4.4 sne 03/01/19 Fixed violations according to MISRAC-2012
standards modified the code for below violations, No brackets to then/else,
Literal value requires a U suffix,Function return type inconsistent,Logical
conjunctions need brackets, Declared the pointer param as Pointer to const,
Procedure has more than one exit point. 4.4 sne 03/04/19 Added Support for
Versal. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/src/xwdttb_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xwdttb_sinit.c @addtogroup
xwdttb_v4_4 @{ This file contains static initialization method for Xilinx AXI
Timebase Window Watchdog Timer core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- --- -------- 1.00 sha 12/17/15 First release. 4.0 sha 01/29/16
Updated version to 4.0 as it is newly added file in driver version 4.0. 4.3 srm
01/30/18 Added doxygen tags </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/wdttb/src/xwdttb_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.02a asa 09/07/13 Created uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/xadcps/data/xadcps.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps_intr_example.c This file
contains a design example using the driver functions of the XADC/ADC driver.
This example here shows the usage of the driver/device in interrupt mode to
handle on-chip temperature and voltage alarm interrupts. @note This code assumes
that no Operating System is being used. The values of the on-chip temperature
and the on-chip Vccaux voltage are read from the device and then the alarm
thresholds are set in such a manner that the alarms occur. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a bss 01/20/12 First
release 2.2 ms 01/23/17 Modified xil_printf statement in main function to ensure
that "Successfully ran" and "Failed" strings are available in all examples. This
is a fix for CR-965028. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xadcps/examples/xadcps_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadc_polled_printf_example.c
This file contains a design example using the driver functions of the XADC
driver. The example here shows the driver/device in polled mode to check the on-
chip temperature and voltages. @note This examples also assumes that there is a
STDIO device in the system. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ----- -------- 1.00a ssb 12/22/11 First release based on the XPS/AXI
SysMon driver 2.2 ms 01/23/17 Added xil_printf statement in main function to
ensure that "Successfully ran" and "Failed" strings are available in all
examples. This is a fix for CR-965028. ms 04/05/17 Modified Comment lines in
functions to recognize it as documentation block for doxygen generation. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/xadcps/examples/xadcps_polled_printf_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps.c @addtogroup
xadcps_v2_3 @{ This file contains the driver API functions that can be used to
access the XADC device. Refer to the xadcps.h header file for more information
about this driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ----- -------- 1.00a ssb 12/22/11 First release based on the XPS/AXI xadc
driver 1.01a bss 02/18/13 Modified
XAdcPs_SetSeqChEnables,XAdcPs_SetSeqAvgEnables XAdcPs_SetSeqInputMode and
XAdcPs_SetSeqAcqTime APIs to fix CR 693371 2.1 bss 08/05/14 Modified Assert for
XAdcPs_SetSingleChParams to fix CR 807563. 2.2 bss 04/27/14 Modified to use
correct Device Config base address (CR854437). 2.3 mn 07/09/18 Fix Doxygen
warning </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xadcps/src/xadcps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps.h @addtogroup
xadcps_v2_3 @{ @details The XAdcPs driver supports the Xilinx XADC/ADC device.
The XADC/ADC device has the following features: - 10-bit, 200-KSPS (kilo samples
per second) Analog-to-Digital Converter (ADC) - Monitoring of on-chip supply
voltages and temperature - 1 dedicated differential analog-input pair and 16
auxiliary differential analog-input pairs - Automatic alarms based on user
defined limits for the on-chip supply voltages and temperature - Automatic
Channel Sequencer, programmable averaging, programmable acquisition time for the
external inputs, unipolar or differential input selection for the external
inputs - Inbuilt Calibration - Optional interrupt request generation The user
should refer to the hardware device specification for detailed information about
the device. This header file contains the prototypes of driver functions that
can be used to access the XADC/ADC device. <b> XADC Channel Sequencer Modes </b>
The XADC Channel Sequencer supports the following operating modes: - <b> Default
</b>: This is the default mode after power up. In this mode of operation the
XADC operates in a sequence mode, monitoring the on chip sensors: Temperature,
VCCINT, and VCCAUX. - <b> One pass through sequence </b>: In this mode the XADC
converts the channels enabled in the Sequencer Channel Enable registers for a
single pass and then stops. - <b> Continuous cycling of sequence </b>: In this
mode the XADC converts the channels enabled in the Sequencer Channel Enable
registers continuously. - <b> Single channel mode</b>: In this mode the XADC
Channel Sequencer is disabled and the XADC operates in a Single Channel Mode.
The XADC can operate either in a Continuous or Event driven sampling mode in the
single channel mode. - <b> Simultaneous Sampling Mode</b>: In this mode the XADC
Channel Sequencer will automatically sequence through eight fixed pairs of
auxiliary analog input channels for simulataneous conversion. - <b> Independent
ADC mode</b>: In this mode the first ADC (A) is used to is used to implement a
fixed monitoring mode similar to the default mode but the alarm fucntions ar
eenabled. The second ADC (B) is available to be used with external analog input
channels only. Read the XADC spec for more information about the sequencer
modes. <b> Initialization and Configuration </b> The device driver enables
higher layer software (e.g., an application) to communicate to the XADC/ADC
device. XAdcPs_CfgInitialize() API is used to initialize the XADC/ADC device.
The user needs to first call the XAdcPs_LookupConfig() API which returns the
Configuration structure pointer which is passed as a parameter to the
XAdcPs_CfgInitialize() API. <b>Interrupts</b> The XADC/ADC device supports
interrupt driven mode and the default operation mode is polling mode. The
interrupt mode is available only if hardware is configured to support
interrupts. This driver does not provide a Interrupt Service Routine (ISR) for
the device. It is the responsibility of the application to provide one if
needed. Refer to the interrupt example provided with this driver for details on
using the device in interrupt mode. <b> Virtual Memory </b> This driver supports
Virtual Memory. The RTOS is responsible for calculating the correct device base
address in Virtual Memory space. <b> Threads </b> This driver is not thread
safe. Any needs for threads or thread mutual exclusion must be satisfied by the
layer above this driver. <b> Asserts </b> Asserts are used within all Xilinx
drivers to enforce constraints on argument values. Asserts can be turned off on
a system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The XAdcPs driver is composed
of several source files. This allows the user to build and link only those parts
of the driver that are necessary. <b> Limitations of the driver </b> XADC/ADC
device can be accessed through the JTAG port and the PLB interface. The driver
implementation does not support the simultaneous access of the device by both
these interfaces. The user has to care of this situation in the user application
code. <br><br> <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.00a ssb 12/22/11 First release based on the XPS/AXI xadc driver 1.01a
bss 02/18/13 Modified XAdcPs_SetSeqChEnables,XAdcPs_SetSeqAvgEnables
XAdcPs_SetSeqInputMode and XAdcPs_SetSeqAcqTime APIs in xadcps.c to fix CR
693371 1.03a bss 11/01/13 Modified xadcps_hw.h to use correct Register offsets
CR749687 2.1 bss 08/05/14 Added declarations for XAdcPs_SetSequencerEvent,
XAdcPs_GetSamplingMode, XAdcPs_SetMuxMode, XAdcPs_SetPowerdownMode and
XAdcPs_GetPowerdownMode functions. Modified Assert for XAdcPs_SetSingleChParams
in xadcps.c to fix CR 807563. 2.2 bss 04/27/14 Modified to use correct Device
Config base address in xadcps.c (CR854437). ms 01/23/17 Added xil_printf
statement in main function for all examples to ensure that "Successfully ran"
and "Failed" strings are available in all examples. This is a fix for CR-965028.
ms 03/17/17 Added readme.txt file in examples folder for doxygen generation. ms
04/05/17 Modified Comment lines in functions of xadcps examples to recognize it
as documentation block for doxygen generation. 2.3 mn 07/09/18 Fix Doxygen
warning </pre>

FILES:
XilinxProcessorIPLib/drivers/xadcps/src/xadcps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps_g.c @addtogroup
xadcps_v2_3 @{ This file contains a configuration table that specifies the
configuration of XADC devices in the system when accessing through the Device
Config interface in Zynq. See xadcps.h for more information about this driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.00a ssb 12/22/11 First release based on the XPS/AXI xadc driver
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xadcps/src/xadcps_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps_hw.h @addtogroup
xadcps_v2_3 @{ This header file contains identifiers and basic driver functions
(or macros) that can be used to access the XADC device through the Device Config
Interface of the Zynq. Refer to the device specification for more information
about this driver. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ----- -------- 1.00a bss 12/22/11 First release based on the XPS/AXI xadc
driver 1.03a bss 11/01/13 Modified macros to use correct Register offsets
CR749687 </pre>

FILES:
XilinxProcessorIPLib/drivers/xadcps/src/xadcps_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps_intr.c @addtogroup
xadcps_v2_3 @{ This file contains interrupt handling API functions of the XADC
device. The device must be configured at hardware build time to support
interrupt for all the functions in this file to work. Refer to xadcps.h header
file and device specification for more information. @note Calling the interrupt
functions without including the interrupt component will result in asserts if
asserts are enabled, and will result in a unpredictable behavior if the asserts
are not enabled. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -----
-------- 1.00a ssb 12/22/11 First release based on the XPS/AXI xadc driver
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xadcps/src/xadcps_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps_selftest.c @addtogroup
xadcps_v2_3 @{ This file contains a diagnostic self test function for the XAdcPs
driver. The self test function does a simple read/write test of the Alarm
Threshold Register. See xadcps.h for more information. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ----- -------- 1.00a ssb
12/22/11 First release based on the XPS/AXI xadc driver </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xadcps/src/xadcps_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xadcps_sinit.c @addtogroup
xadcps_v2_3 @{ This file contains the implementation of the XAdcPs driver's
static initialization functionality. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ----- -------- 1.00a ssb 12/22/11 First release based on
the XPS/AXI XADC driver </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xadcps/src/xadcps_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: 01/30/19 tk
First Release

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/data/xdmapcie.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 tk 01/30/2019 First release uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/data/xdmapcie.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie_rc_enumerate_example.c
This file contains a design example for using XDMA PCIe IP and its driver. This
is an example to show the usage of driver APIs when XDMA PCIe IP is configured
as a Root Port. The example initializes the XDMA PCIe IP and shows how to
enumerate the PCIe system. @note This example should be used only when XDMA PCIe
IP is configured as root complex. This code will illustrate how the XDmaPcie IP
and its standalone driver can be used to: - Initialize a XDMA PCIe IP core built
as a root complex - Enumerate PCIe end points in the system - Assign BARs to end
points - find capabilities on end point Please note that this example enumerates
and initializes PCIe end points only. We tried to use as much of the driver's
API calls as possible to show the reader how each call could be used and that
probably made the example not the shortest way of doing the tasks shown as they
could be done. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 tk 01/30/2019 Initial version of XDMA PCIe root complex example
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/examples/xdmapcie_rc_enumerate_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie.c Implements all of
functions for XDmaPcie IP driver except interrupts and initialization. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 tk 01/30/2019
First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie.h This file contains
the software API definition of the Xilinx XDMA PCIe IP (XDma_0). This driver
provides "C" function interface to application/upper layer to access the
hardware. <b>Features</b> The driver provides its user with entry points - To
initialize and configure itself and the hardware - To access PCIe configuration
space locally <b>Driver Initialization & Configuration</b> The XDmaPcie_Config
structure is used by the driver to configure itself. This configuration
structure is typically created by the tool-chain based on HW build properties.
To support multiple runtime loading and initialization strategies employed by
various operating systems, the driver instance can be initialized in the
following way: - XDmaPcie_LookupConfig(DeviceId) - Use the device identifier to
find the static configuration structure defined in xdmapcie_g.c. This is setup
by the tools. - XDmaPcie_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddr) -
Uses a configuration structure provided by the caller. If running in a system
with address translation, the provided virtual memory base address replaces the
physical address present in the configuration structure. <b>Interrupt
Management</b> The XDmaPcie driver provides interrupt management functions. It
allows the caller to enable/disable each individual interrupt as well as
get/clear pending interrupts. Implementation of callback handlers is left to the
user. @note <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 tk 01/30/2019 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie_caps.c Implements all
of supportive functions to expose PCIe capabilities. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 tk 01/30/2019 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie_caps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie_common.h Definitions
of commonly used macros. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.0 tk 01/30/2019 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie_hw.h This header file
contains identifiers and basic driver functions for the XDmaPcie device driver.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 tk 01/30/2019 First release </pre>

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie_intr.c This file
implements interrupt functions for the XDmaPcie IP <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 tk 01/30/2019 First release </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xdmapcie_sinit.c This file
contains the implementation of XDMA PCIe driver's static initialization
functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 tk 01/30/2019 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xdmapcie/src/xdmapcie_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: 06/16/17 hk
First Release

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/data/xxvethernet.mdd
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: 06/16/17 hk
First Release 08/27/18 rsp Fix error generating bsp sources for non-supported
designs. In get_targetip and is_ethsupported_target functions avoid calling
get_cells/get_property API's with NULL handle. 09/26/18 rsp Fix interrupt ID
generation for ZynqMP designs. 10/31/18 rsp Use identifiable suffix for global
variables to avoid conflicts. 06/21/19 rsp Fix bsp generation error for
axis_rx_0 external port design. uses "xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/data/xxvethernet.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xxxvethernet_example.h Defines
common data types, prototypes, and includes the proper headers for use with the
Xxv Ethernet and USXGMII example code residing in this directory. This file
along with xxxvethernet_example_util.c are utilized with the specific example
code in the other source code files provided. These examples are designed to be
compiled and utilized within the EDK standalone BSP development environment. The
readme file contains more information on build requirements needed by these
examples. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.0 hk 06/16/17 First release hk 02/15/18 Add support for USXGMII </pre>

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/examples/xxxvethernet_example.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xxxvethernet_example_intr_mcdma.c Implements examples that utilize the Xxv
Ethernet's interrupt driven MCDMA packet transfer mode to send and receive
frames. This example demonstrates how to perform a simple send and receive.
Functional guide to example: - XxvEthernetSgDmaIntrSingleFrameExample
demonstrates the simplest way to send and receive frames in interrupt driven
mode. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0
hk 06/16/17 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/examples/xxxvethernet_example_intr_mcdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xxxvethernet_example_util.c
This file implements the utility functions for the Xxv Ethernet and USXGMII
example code. It contains functions to setup USXGMII autonegotiation at desired
settings and to bypass autonegotiation. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 hk 06/16/17 First release hk 02/15/18 Add
support for USXGMII </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/examples/xxxvethernet_example_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xxxvethernet_usxgmii_mcdma_intr_example.c Implements examples that utilize
USXGMII's interrupt driven MCDMA packet transfer mode to send and receive
frames. This example demonstrates how to perform a simple send and receive.
USXGMII is setup at 1G speed by default (can be setup at 2.5G). USXGMII needs to
be looped back externally on the HW for this example. The GT reference clock
needs to be set to 161.16035455278MHz for USXGMII. Functional guide to example:
- XxvEthernetSgDmaIntrSingleFrameExample demonstrates the simplest way to send
and receive frames in interrupt driven mode. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.0 hk 06/16/17 First release </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/examples/xxxvethernet_usxgmii_example_intr_mcdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xxxvethernet.c @addtogroup
xxvethernet_v1_3 @{ This file implements all the XXV ethernet functions to
initialize, start, stop, reset and reconfigure the MAC. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 hk 6/16/17 First release
hk 2/15/18 Add support for USXGMII </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/src/xxxvethernet.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xxxvethernet.h @addtogroup
xxvethernet_v1_3 @{ @details The Xilinx XXV Ethernet MAC driver component. This
driver supports both XXV Ethernet core and USXGMII core on Zynq Ultrascale+
MPSoC. The MAC portion of USXMGII and XXV ethernet is similar. Speed supported
for XXV Ethernet core is 10Gbps. Speed supported for USXGMII core is 1Gbps or
2.5Gbps. For a full description of XXV Ethernet features, please see the
hardware spec. This driver supports the following features: - Access to host
interface registers - Interfacing to target MCDMA device via application - Full
duplex operation - Automatic PAD & FCS insertion and stripping (programmable) -
Jumbo frame support For full description of USXGMII features, please refer to
hardware spec. In addition to the above MAC features, USXGMII core supports
USXGMII PHY functionality. This driver supports the same. <h2>Driver
Description</h2> The device driver enables higher layer software (e.g., an
application) to configure an Xxv Ethernet device. It is intended that this
driver be used in cooperation with another MCDMA driver for data communication..
<h2>Initialization & Configuration</h2> The XXxvEthernet_Config structure can be
used by the driver to configure itself. This configuration structure is
typically created by the tool-chain based on hardware build properties. The
driver instance can be initialized using the XXvEthernet_CfgInitialze() routine.
<h2>Interrupts and Asynchronous Callbacks</h2> The driver has no dependencies on
the interrupt controller. It provides no interrupt handlers. The application/OS
software should set up its own interrupt handlers if required based on the
target DMA device. <h2>Device Reset</h2> When an Xxv Ethernet device is
connected up to a MCDMA core in hardware, reset is controlled by the latter. If
a reset is performed, the calling code should also reconfigure and reapply the
proper settings in the Xxv Ethernet device. When an Xxv Ethernet device reset is
required, XXxvEthernet_Reset() should be utilized. For GT/Serdes reset, refer to
the example. <h2>Transferring Data</h2> The Xxv Ethernet core by itself is not
capable of transmitting or receiving data in any meaningful way. Instead the Xxv
Ethernet device needs to be connected to a FIFO or DMA core in hardware,
currently MCDMA is supported. This Xxv Ethernet driver is modeled in a similar
fashion where the application code or O/S adapter driver needs to make use of a
separate MCDMA driver in connection with this driver to establish meaningful
communication over Ethernet. <h2>PHY Communication</h2> XXV Ethernet core: This
device supports clause 49 10GBaseKR at the moment. There is no autonegotiation
enabled by default - the autonegotiation speed is limited to 10G. USXGMII core:
This driver supports USXMGII autonegotiation at 1G and and 2.5G. The core also
supports 10G and 5G speeds but it is not validated with this driver. There is
also an option to bypass autonegotiation. <h2>Asserts</h2> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. For deployment use -DNDEBUG compiler switch
to remove assert code. @note Xilinx drivers are typically composed of two
components, one is the driver and the other is the adapter. The driver is
independent of OS and processor and is intended to be highly portable. The
adapter is OS-specific and facilitates communication between the driver and an
OS. <br><br> This driver is intended to be RTOS and processor independent. Any
needs for dynamic memory management, threads or thread mutual exclusion, or
cache control must be satisfied by the layer above this driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 hk 6/16/17
First release hk 2/15/18 Add support for USXGMII 1.1 mj 3/30/18 Add Macro
XXxvEthernet_IsMcDma(InstancePtr) to check McDma is connected or not. </pre>

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/src/xxxvethernet.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xxxvethernet_hw.h @addtogroup
xxvethernet_v1_3 @{ This file contains definitions for register offset, masks
and low level hardware functions. @note <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 hk 6/16/17 First release hk 2/15/18 Add support
for USXGMII </pre>

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/src/xxxvethernet_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xxxvethernet_sinit.c
@addtogroup xxvethernet_v1_3 @{ This file contains static initialization
functionality for XXV Ethernet driver. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 hk 6/16/17 First release 1.1 mj 3/30/18 Add
XXxvEthernet_LookupConfigBaseAddr(UINTPTR Baseaddr) API to lookup config by base
address. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/xxvethernet/src/xxxvethernet_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ----- ---------- 6.0 adk 19/12/13 First release. 7.1 ms 01/31/17
Updated the parameter naming from XPAR_YCRCB2RGB_NUM_INSTANCES to
XPAR_XYCRCB2RGB_NUM_INSTANCES to avoid compilation failure for
XPAR_YCRCB2RGB_NUM_INSTANCES as the tools are generating
XPAR_XYCRCB2RGB_NUM_INSTANCES in the generated xycrcb2rgb_g.c for fixing MISRA-C
files. This is a fix for CR-967548 based on the update in the tools.

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/data/ycrcb2rgb.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ycrcb2rgb_example.c This file
demonstrates how to use Xilinx YCrCb to RGB Color Space Converter (YCrCb2RGB)
driver on Xilinx YCrCb to RGB Color Space Converter (YCrCb2RGB) core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 7.00 adk 07/14/14
First release. </pre>

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/examples/ycrcb2rgb_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ycrcb2rgb_selftest_example.c
This file contains an example using the XYCrCb2RGB driver to do self test on the
device. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 7.0 adk 02/10/14 First Release. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/examples/ycrcb2rgb_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xycrcb2rgb.c @addtogroup
ycrcb2rgb_v7_1 @{ This file contains the implementation of the interface
functions for YCRCB2RGB core. Refer to the header file xycrcb2rgb.h for more
detailed information. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 5.00a tb 02/28/12 Updated for YCRCB2RGB v5.00.a. 7.0 adk 01/31/14
Changed the file name from "ycrcb2rgb.c" to "xycrcb2rgb.c". Implemented
following functions: XYCrCb2Rgb_CfgInitialize, XYCrCb2Rgb_EnableDbgByPass,
XYCrCb2Rgb_IsDbgByPassEnabled, XYCrCb2Rgb_DisableDbgBypass,
XYCrCb2Rgb_EnableDbgTestPattern, XYCrCb2Rgb_IsDbgTestPatternEnabled,
XYCrCb2Rgb_DisableDbgTestPattern, XYCrCb2Rgb_GetVersion,
XYCrCb2Rgb_GetDbgFrameCount, XYCrCb2Rgb_GetDbgLineCount,
XYCrCb2Rgb_GetDbgPixelCount, XYCrCb2Rgb_Setup, XYCrCb2Rgb_SetActiveSize,
XYCrCb2Rgb_GetActiveSize, XYCrCb2Rgb_SetRGBMax, XYCrCb2Rgb_GetRGBMax,
XYCrCb2Rgb_SetRGBMin, XYCrCb2Rgb_GetRGBMin, XYCrCb2Rgb_SetROffset,
XYCrCb2Rgb_GetROffset, XYCrCb2Rgb_SetGOffset, XYCrCb2Rgb_GetGOffset,
XYCrCb2Rgb_SetBOffset, XYCrCb2Rgb_GetBOffset, XYCrCb2Rgb_SetCoefs,
XYCrCb2Rgb_GetCoefs, XYCrCb2Rgb_Select_Standard,
XYCrCb2Rgb_Coefficient_Translation, XYCrCb2Rgb_Select_OutputRange. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/src/xycrcb2rgb.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xycrcb2rgb.h @addtogroup
ycrcb2rgb_v7_1 @{ @details This header file contains identifiers and register-
level driver functions (or macros), range macros, structure typedefs that can be
used to access the Xilinx YCRCB2RGB core. The YCrCb to RGB Color-Space Convertor
core is a simplified 3x3 matrix multiplier converts three input color samples to
three output samples in a single clock cycle. The core supports four common
format conversions as well as a custom mode that allows for a user-defined
transform. The core is capable of a maximum resolution of 7680 columns by 7680
rows with 8, 10, 12, or 16 bits per pixel. <b>Initialization & Configuration</b>
The device driver enables higher layer software (e.g., an application) to
communicate to the YCRCB2RGB core. XYCrCb2Rgb_CfgInitialize() API is used to
initialize the YCRCB2RGB core. The user needs to first call the
XYCrCb2Rgb_LookupConfig() API which returns the Configuration structure pointer
which is passed as a parameter to the XYCrCb2Rgb_CfgInitialize() API. <b>
Interrupts </b> The driver provides an interrupt handler XYCrCb2Rgb_IntrHandler
for handling the interrupt from the YCRCB2RGB core. The users of this driver
have to register this handler with the interrupt system and provide the callback
functions by using XYCrCb2Rgb_SetCallBack API. <b> Virtual Memory </b> This
driver supports Virtual Memory. The RTOS is responsible for calculating the
correct device base address in Virtual Memory space. <b> Threads </b> This
driver is not thread safe. Any needs for threads or thread mutual exclusion must
be satisfied by the layer above this driver. <b> Asserts </b> Asserts are used
within all Xilinx drivers to enforce constraints on argument values. Asserts can
be turned off on a system-wide basis by defining, at compile time, the NDEBUG
identifier. By default, asserts are turned on and it is recommended that users
leave asserts on during development. <b> Building the driver </b> The XYCrCb2Rgb
driver is composed of several source files. This allows the user to build and
link only those parts of the driver that are necessary. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 5.00a tb 02/28/12 Updated
for YCRCB2RGB V5.00.a 5.01a bao 12/28/12 Converted from xio.h to xil_io.h,
translating basic types, MB cache functions, exceptions and assertions to xil_io
format. 6.0 adk 19/12/13 Updated as per the New Tcl API's 7.0 adk 01/31/14
Changed the file name from "ycrcb2rgb.h" to "xycrcb2rgb.h". Moved register
offsets and bit definitions from ycrcb2rgb.h file to xycrcb2rgb_hw.h file.
Removed YCC_TIMING_STATUS register offset because this register is not present
in latest product guide. Removed following function macros: YCC_Enable,
YCC_Disable, YCC_RegUpdateEnable, YCC_RegUpdateDisable, YCC_Reset,
YCC_ClearReset, YCC_AutoSyncReset, ycc_max.. Removed following functions:
YCC_select_standard, YCC_coefficient_translation, YCC_set_coefficients,
YCC_get_coefficients. Added following handler types as enum:
XYCC_HANDLER_PROCSTART, XYCC_HANDLER_FRAMEDONE, XYCC_HANDLER_ERROR. Added
following standard types as enum: XYCC_STANDARD_ITU_601_SD,
XYCC_STANDARD_ITU_709_NTSC, XYCC_STANDARD_ITU_709_PAL, XYCC_STANDARD_YUV,
XYCC_STANDARD_CUSTOM. Added following output ranges as enum: XYCC_TV_16_TO_240,
XYCC_STUDIO_16_TO_235, XYCC_GRAPHICS_0_TO_255. Added range macros for
ActiveSize, RGBMAX, RGBMIN, ROFFSET, GOFFSET, BOFFSET registers. Added following
function macros: XYCrCb2Rgb_IntrEnable, XYCrCb2Rgb_IntrDisable,
XYCrCb2Rgb_StatusGetPending, XYCrCb2Rgb_IntrGetPending, XYCrCb2Rgb_IntrClear,
XYCrCb2Rgb_Reset, XYCrCb2Rgb_Enable, XYCrCb2Rgb_Disable, XYCrCb2Rgb_Start,
XYCrCb2Rgb_Stop, XYCrCb2Rgb_RegUpdateEnable, XYCrCb2Rgb_RegUpdateDisable,
XYCrCb2Rgb_SyncReset, XYCrCb2Rgb_Max Added core, configuration and coefficient
structure. Renamed ycc_coef_inputs -> XYCrCb2Rgb_Coef_Inputs and
ycc_coef_outputs - > XYCrCb2Rgb_Coef_Outputs. Added callback functions typedef.
Implemented XYCrCb2Rgb_LookupConfig in xycrcb2rgb_sinit.c Implemented
XYCrCb2Rgb_SelfTest in xycrcb2rgb_selftest.c Implemented XYCrCb2Rgb_IntrHandler,
XYCrCb2Rgb_SetCallBack in xycrcb2rgb_intr.c. Implemented following functions in
xycrcb2rgb.c: XYCrCb2Rgb_CfgInitialize, XYCrCb2Rgb_EnableDbgByPass,
XYCrCb2Rgb_IsDbgByPassEnabled, XYCrCb2Rgb_DisableDbgBypass,
XYCrCb2Rgb_EnableDbgTestPattern, XYCrCb2Rgb_IsDbgTestPatternEnabled,
XYCrCb2Rgb_DisableDbgTestPattern, XYCrCb2Rgb_GetVersion,
XYCrCb2Rgb_GetDbgFrameCount, XYCrCb2Rgb_GetDbgLineCount,
XYCrCb2Rgb_GetDbgPixelCount, XYCrCb2Rgb_Setup, XYCrCb2Rgb_SetActiveSize,
XYCrCb2Rgb_GetActiveSize, XYCrCb2Rgb_SetRGBMax, XYCrCb2Rgb_GetRGBMax,
XYCrCb2Rgb_SetRGBMin, XYCrCb2Rgb_GetRGBMin, XYCrCb2Rgb_SetROffset,
XYCrCb2Rgb_GetROffset, XYCrCb2Rgb_SetGOffset, XYCrCb2Rgb_GetGOffset,
XYCrCb2Rgb_SetBOffset, XYCrCb2Rgb_GetBOffset, XYCrCb2Rgb_SetCoefs,
XYCrCb2Rgb_GetCoefs, XYCrCb2Rgb_Select_Standard,
XYCrCb2Rgb_Coefficient_Translation, XYCrCb2Rgb_Select_OutputRange. 7.1 ms
01/31/17 Updated the parameter naming from XPAR_YCRCB2RGB_NUM_INSTANCES to
XPAR_XYCRCB2RGB_NUM_INSTANCES to avoid compilation failure for
XPAR_YCRCB2RGB_NUM_INSTANCES as the tools are generating
XPAR_XYCRCB2RGB_NUM_INSTANCES in the generated xycrcb2rgb_g.c for fixing MISRA-C
files. This is a fix for CR-967548 based on the update in the tools. ms 03/17/17
Added readme.txt file in examples folder for doxygen generation. </pre>

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/src/xycrcb2rgb.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xycrcb2rgb_hw.h @addtogroup
ycrcb2rgb_v7_1 @{ This header file contains identifiers and register-level
driver functions (or macros) that can be used to access the Xilinx YCrCb to RGB
Color Space Converter (YCRCB2RGB) core. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------ -------- 7.0 adk 01/31/14 First release. Added the register
offsets and bit masks for the registers. Added backward compatibility macros.
</pre>

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/src/xycrcb2rgb_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xycrcb2rgb_intr.c @addtogroup
ycrcb2rgb_v7_1 @{ This file contains interrupt related functions for the
YCRCB2RGB core. Please see xycrcb2rgb.h for more details of the driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 7.0 adk
01/31/14 First Release. Implemented the following functions:
XYCrCb2Rgb_IntrHandler XYCrCb2Rgb_SetCallBack </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/src/xycrcb2rgb_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xycrcb2rgb_selftest.c
@addtogroup ycrcb2rgb_v7_1 @{ This file contains the self-test function for the
YCRCB2RGB core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 7.0 adk 02/03/14 First Release. Implemented the following function:
XYCrCb2Rgb_SelfTest </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/src/xycrcb2rgb_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xycrcb2rgb_sinit.c @addtogroup
ycrcb2rgb_v7_1 @{ This file contains static initialization methods for Xilinx
YCRCB2RGB core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 7.0 adk 02/10/14 First release. Implemented following function:
XYCrCb2Rgb_Config. 7.1 ms 01/31/17 Updated the parameter naming from
XPAR_YCRCB2RGB_NUM_INSTANCES to XPAR_XYCRCB2RGB_NUM_INSTANCES to avoid
compilation failure for XPAR_YCRCB2RGB_NUM_INSTANCES as the tools are generating
XPAR_XYCRCB2RGB_NUM_INSTANCES in the generated xycrcb2rgb_g.c for fixing MISRA-C
files. This is a fix for CR-967548 based on the update in the tools. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/ycrcb2rgb/src/xycrcb2rgb_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 vnsld 2/24/15 First release 1.3 mus 08/14/17
Export cache coherency information 1.6 adk 07/09/18 Use -hier option while using
get_cells command to support hierarchical designs. 1.7 adk 08/03/19 Add support
for versal. 1.8 mus 07/30/19 Added CCI support for Versal at EL1 NS uses
"xillib.tcl"

FILES:
XilinxProcessorIPLib/drivers/zdma/data/zdma.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes -------- ------ -------- 1.5 adk 11/22/17 Added peripheral test app
support. Uses $XILINX_EDK/bin/lib/xillib_sw.tcl Software Project Types (swproj):
0 : MemoryTest - Calls basic memorytest routines from common driver dir 1 :
PeripheralTest - Calls any existing polled_example and/or selftest TCL
Procedures:

FILES:
XilinxProcessorIPLib/drivers/zdma/data/zdma_tapp.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_linear_example.c This
file contains the example using XZDma driver to do data transfer in Linear mode
on ZDMA device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.0 vns 2/27/15 First release ms 04/05/17 Modified comment lines
notation in functions to avoid unnecessary description to get displayed while
generating doxygen. 1.3 mus 08/14/17 Do not perform cache operations if CCI is
enabled 1.4 adk 11/02/17 Updated example to fix compilation errors for IAR
compiler. 1.7 adk 21/03/19 Fix data alignment in the example for IAR compiler.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/examples/xzdma_linear_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_linkedlist_example.c This
file contains the example using XZDma driver to do data transfer in Linked list
mode on ZDMA device. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 1.0 vns 2/27/15 First release ms 04/05/17 Modified comment lines
notation in functions to avoid unnecessary description to get displayed while
generating doxygen. 1.3 mus 08/14/17 Do not perform cache operations if CCI is
enabled 1.4 adk 11/02/17 Updated example to fix compilation errors for IAR
compiler. 1.7 adk 21/03/19 Fix alignment pragmas in the example for IAR
compiler. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/examples/xzdma_linkedlist_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_readonlymode_example.c
This file contains the example using XZDma driver to do simple data read on ZDMA
device. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
1.0 vns 2/27/15 First release ms 04/05/17 Modified comment lines notation in
functions to avoid unnecessary description to get displayed while generating
doxygen and also changed filename tag to include the file in doxygen examples.
1.3 mus 08/14/17 Do not perform cache operations if CCI is enabled 1.4 adk
11/02/17 Updated example to fix compilation errors for IAR compiler. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/examples/xzdma_readonlymode_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_selftest_example.c This
file contains an example using the XZDma driver to do self test on the device.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vns
2/27/15 First release 1.5 adk 11/22/17 Added peripheral test app support. </pre>
Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/examples/xzdma_selftest_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_simple_example.c This
file contains the example using XZDma driver to do simple data transfer in
Normal mode on ZDMA device for 1MB data transfer. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 vns 2/27/15 First release vns
10/13/15 Declared static array rather than hard code memory. ms 04/05/17
Modified comment lines notation in functions to avoid unnecessary description to
get displayed while generating doxygen. 1.3 mus 08/14/17 Do not perform cache
operations if CCI is enabled 1.4 adk 11/02/17 Updated example to fix compilation
errors for IAR compiler. 1.5 adk 11/22/17 Added peripheral test app support.
12/11/17 Fixed peripheral test app generation issues when dma buffers are
configured on OCM memory(CR990806). 18/01/18 Remove unnecessary column in
XIntc_Connect() API. 01/02/18 Added support for error handling. 1.7 adk 21/03/19
Fix alignment pragmas in the example for IAR compiler. 19/04/19 Rename the dma
buffers to avoid peripheral test compilation errors with armclang compiler.
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/examples/xzdma_simple_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_writeonlymode_example.c
This file contains the example using XZDma driver to do simple data transfer in
Write only mode on ZDMA device. In this mode data will be predefined and will be
repetitively written into the given address and for given size. For ADMA only 2
words are repeated and for GDMA 4 words are repeated. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vns 2/27/15 First
release ms 04/05/17 Modified comment lines notation in functions to avoid
unnecessary description to get displayed while generating doxygen. 1.3 mus
08/14/17 Do not perform cache operations if CCI is enabled 1.4 adk 11/02/17
Updated example to fix compilation errors for IAR compiler. 1.7 adk 18/03/19
Update the example data verification check to support versal adma IP. 1.7 adk
21/03/19 Fix alignment pragmas in the example for IAR compiler. </pre> Include
Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/examples/xzdma_writeonlymode_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma.c @addtogroup zdma_v1_7
@{ This file contains the implementation of the interface functions for ZDMA
driver. Refer to the header file xzdma.h for more detailed information. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vns 2/27/15
First release vns 16/10/15 Corrected Destination descriptor address calculation
in XZDma_CreateBDList API 1.1 vns 05/11/15 Modified XZDma_SetMode to return
XST_FAILURE on selecting DMA mode other than normal mode in scatter gather mode
data transfer and corrected XZDma_SetChDataConfig API to set over fetch and src
issue parameters correctly. 1.3 mus 08/14/17 Add CCI support for A53 in EL1 NS
1.8 aru 07/02/19 Fix coverity warnings hk 07/19/19 Remove Versal clock and
routing workarounds. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/src/xzdma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma.h @addtogroup zdma_v1_7
@{ @details ZDMA is a general purpose DMA designed to support memory to memory
and memory to IO buffer transfers. ZynqMP has two instance of general purpose
ZDMA. One is located in FPD (full power domain) which is GDMA and other is
located in LPD (low power domain) which is ADMA. GMDA & ADMA are configured each
with 8 DMA channels and and each channel can be programmed secure or non-secure.
Each channel is divided into two functional sides, Source (Read) and Destination
(Write). Each DMA channel can be independently programmed in one of following
DMA modes. - Simple DMA - Normal data transfer from source to destination. -
Write Only mode. - Read Only mode. - Scatter Gather DMA - Only Normal mode it
can't support other two modes. In Scatter gather descriptor can be of 3 types -
Linear descriptor. - Linked list descriptor - Hybrid descriptor (Combination of
both Linear and Linked list) Our driver will not support Hybrid type of
descriptor. <b>Initialization & Configuration</b> The device driver enables
higher layer software (e.g., an application) to communicate to the ZDMA core.
XZDma_CfgInitialize() API is used to initialize the ZDMA core. The user needs to
first call the XZDma_LookupConfig() API which returns the Configuration
structure pointer which is passed as a parameter to the XZDma_CfgInitialize()
API. <b> Interrupts </b> The driver provides an interrupt handler
XZDma_IntrHandler for handling the interrupt from the ZDMA core. The users of
this driver have to register this handler with the interrupt system and provide
the callback functions by using XZDma_SetCallBack API. In this version
Descriptor done option is disabled. <b> Virtual Memory </b> This driver supports
Virtual Memory. The RTOS is responsible for calculating the correct device base
address in Virtual Memory space. <b> Threads </b> This driver is not thread
safe. Any needs for threads or thread mutual exclusion must be satisfied by the
layer above this driver. <b> Asserts </b> Asserts are used within all Xilinx
drivers to enforce constraints on argument values. Asserts can be turned off on
a system-wide basis by defining, at compile time, the NDEBUG identifier. By
default, asserts are turned on and it is recommended that users leave asserts on
during development. <b> Building the driver </b> The XZDma driver is composed of
several source files. This allows the user to build and link only those parts of
the driver that are necessary. This header file contains identifiers and
register-level driver functions (or macros), range macros, structure typedefs
that can be used to access the Xilinx ZDMA core instance. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vns 2/27/15 First
release 1.1 vns 15/02/16 Corrected Destination descriptor address calculation in
XZDma_CreateBDList API Modified XZDma_SetMode to return XST_FAILURE on selecting
DMA mode other than normal mode in scatter gather mode data transfer and
corrected XZDma_SetChDataConfig API to set over fetch and src issue parameters
correctly. ms 03/17/17 Added readme.txt file in examples folder for doxygen
generation. ms 04/05/17 Modified comment lines notation in functions of zdma
examples to avoid unnecessary description to get displayed while generating
doxygen and also changed filename tag to include the readonly mode example file
in doxygen. 1.3 mus 08/14/17 Update cache coherency information of the interface
in its config structure. 1.4 adk 11/02/17 Updated examples to fix compilation
errors for IAR compiler. 1.5 adk 11/22/17 Added peripheral test app support for
ZDMA driver. 12/11/17 Fixed peripheral test app generation issues when dma
buffers are configured on OCM memory(CR990806). 1.6 adk 13/07/18 Fixed doxygen
warnings in the driver(CR1006353) Fixed cppcheck warnings and coverity tool
reported errors in the driver(CR1006353). 19/07/18 Fixed cppcheck warning in the
driver. 1.6 aru 08/18/18 Resolved MISRA-C mandatory violations. 1.7 adk 08/03/19
Added support for versal IP. 1.7 adk 18/03/19 Updated the writeonly mode example
data verification check to support versal adma IP. </pre>

FILES:
XilinxProcessorIPLib/drivers/zdma/src/xzdma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_hw.h @addtogroup
zdma_v1_7 @{ This header file contains identifiers and register-level driver
functions (or macros) that can be used to access the Xilinx ZDMA core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vns 2/27/15
First release 1.8 hk 7/19/19 Remove versal clock and routing workarounds. </pre>

FILES:
XilinxProcessorIPLib/drivers/zdma/src/xzdma_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_intr.c @addtogroup
zdma_v1_7 @{ This file contains interrupt related functions of Xilinx ZDMA core.
Please see xzdma.h for more details of the driver. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 vns 2/27/15 First release 1.6 aru
08/18/18 Resolved MISRA-C mandatory violations.(CR1007757) 1.8 aru 07/02/19 Fix
coverity warnings. </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/src/xzdma_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_selftest.c @addtogroup
zdma_v1_7 @{ This file contains the self-test function for the ZDMA core. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vns 2/27/15
First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/src/xzdma_selftest.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xzdma_sinit.c @addtogroup
zdma_v1_7 @{ This file contains static initialization methods for Xilinx ZDMA
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0
vns 2/27/15 First release </pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/zdma/src/xzdma_sinit.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CTRL 0x00 : Control signals bit 0 -
ap_start (Read/Write/COH) bit 1 - ap_done (Read/COR) bit 2 - ap_idle (Read) bit
3 - ap_ready (Read) bit 5 - flush (Read/Write) bit 6 - flush_done (Read) bit 7 -
auto_restart (Read/Write) others - reserved 0x04 : Global Interrupt Enable
Register bit 0 - Global Interrupt Enable (Read/Write) others - reserved 0x08 :
IP Interrupt Enable Register (Read/Write) bit 0 - Channel 0 (ap_done) bit 1 -
Channel 1 (ap_ready) others - reserved 0x0c : IP Interrupt Status Register
(Read/TOW) bit 0 - Channel 0 (ap_done) bit 1 - Channel 1 (ap_ready) others -
reserved 0x10 : Data signal of HwStructIn_status bit 31~0 -
HwStructIn_status[31:0] (Read) 0x14 : Data signal of HwStructIn_status bit 31~0
- HwStructIn_status[63:32] (Read) 0x18 : reserved 0x20 : Data signal of
HwStructIn_mux_context bit 31~0 - HwStructIn_mux_context[31:0] (Read/Write) 0x24
: Data signal of HwStructIn_mux_context bit 31~0 - HwStructIn_mux_context[63:32]
(Read/Write) 0x28 : reserved 0x30 : Data signal of HwStructIn_stream_context bit
31~0 - HwStructIn_stream_context[31:0] (Read/Write) 0x34 : Data signal of
HwStructIn_stream_context bit 31~0 - HwStructIn_stream_context[63:32]
(Read/Write) 0x38 : reserved 0x40 : Data signal of HwStructIn_data_in bit 31~0 -
HwStructIn_data_in[31:0] (Read/Write) 0x44 : reserved 0x60 : Data signal of
HwStructIn_data_out_byte_inf bit 31~0 - HwStructIn_data_out_byte_inf[31:0]
(Read/Write) 0x64 : reserved 0x70 : Data signal of HwStructIn_num_desc bit 7~0 -
HwStructIn_num_desc[7:0] (Read/Write) others - reserved 0x74 : reserved 0x78 :
Data signal of HwStructIn_stream_id_table bit 31~0 -
HwStructIn_stream_id_table[31:0] (Read/Write) 0x7c : Data signal of
HwStructIn_stream_id_table bit 31~0 - HwStructIn_stream_id_table[63:32]
(Read/Write) 0x80 : reserved 0x48 : Data signal of HwStructIn_num_streams_table
bit 31~0 - HwStructIn_num_streams_table[31:0] (Read/Write) 0x4c : Data signal of
HwStructIn_num_streams_table bit 31~0 - HwStructIn_num_streams_table[63:32]
(Read/Write) 0x50 : reserved (SC Self Clear, COR Clear on Read, TOW Toggle on
Write, COH Clear on Handshake)

FILES:
XilinxProcessorIPLib/drivers/mpegtsmux/src/xmpegtsmux_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xmpegtsmux_intr.c @addtogroup
mpegtsmux_v1_0 @{ The functions in this file provides interrupt handler and
associated functions. / Include Files /

FILES:
XilinxProcessorIPLib/drivers/mpegtsmux/src/xmpegtsmux_intr.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

@file idt_8t49n24x.c @addtogroup IDT_8T49N24x @{ <pre> Copyright (c) 2016 Adeas
B.V. All rights reserved. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported
version from the 8T49N28X-FrequencyProgrammingGuide register-calculations.py
script 2.00 MG 16/08/15 Major update 2.10 MG 16/09/05 Added LOS variable 2.20 GM
18/02/08 Converted math.h functions (e.g. ceil) to standard functions 2.30 GM
19/05/09 Added delay in I2cSend API to prevent it from hanging during I2C access
</pre> Include Files /

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/idt_8t49n24x.c
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/idt_8t49n24x.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

@file idt_8t49n24x.h @addtogroup IDT_8T49N24x @{ <pre> Copyright (c) 2016 Adeas
B.V. All rights reserved. MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- X.XX XX YY/MM/DD 1.00 RHe 16/06/20 Initial release. A ported
version from the 8T49N28X-FrequencyProgrammingGuide register-calculations.py
script 2.00 MG 16/08/15 Major update 2.10 MG 16/09/05 Added LOS variable 2.20 GM
18/02/08 Converted math.h functions (e.g. ceil) to standard functions 2.30 GM
19/05/09 Added delay in I2cSend API to prevent it from hanging during I2C access
</pre>

FILES:
XilinxProcessorIPLib/drivers/v_hdmirxss1/examples/xhdmi_example/idt_8t49n24x.h
XilinxProcessorIPLib/drivers/v_hdmitxss1/examples/xhdmi_example/idt_8t49n24x.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 6.4 ms 05/23/17 Defined PSU_PMU macro in
xparameters.h to support XGetPSVersion_Info function for PMUFW. 6.6 srm 10/18/17
Added xsleep_timer_config function to support the sleep configuration using
timers as specified by the user. 6.6 hk 12/15/17 Define platform macros based on
the processor in use. 6.6 mus 01/29/18 Updated to add xen PV console support in
Cortexa53 64 bit BSP. 6.6 mus 02/02/18 Updated get_connected_if proc to detect
the HPC port configured with smart interconnect. 6.6 mus 02/19/18 Updated
handle_profile_opbtimer proc to cover the scenario, where AXI timer is connected
to the INTC through concat IP. 6.6 mus 02/23/18 Export macro for the debug logic
configuration in Cortex R5 BSP, macro value is based on the mld parameter
"lockstep_mode_debug". 6.8 mus 04/27/18 Updated tcl to export definition for
FPU_HARD_FLOAT_ABI_ENABLED flag to bspconfig.h,based on -mfpu-abi option in
extra compiler flags. 6.8 mus 09/10/18 Updated tcl to add -hier option while
using get_cells command. 7.1 mus 03/27/19 Added procs to check if specific
address space is accessible to the cortexr5 processor CR1015725 7.1 mus 05/20/19
Updated outbyte/inbyte in case stdout/stdin is set as "none". This is done to
fix warnings CR1031423 The following are hardcoded for Zynq. We can obtain the
scu timer/gic baseaddr from the xml, but other parameters need to be hardcoded.
hardcode everything.. TODO these hardcoding parameters can be removed. It can
directly come from PS7 IP

FILES:
lib/bsp/standalone/data/standalone.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sleep.c This function provides
a second delay using the Generic Counter register in the ARM Cortex A53 MPcore.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------- -------- 5.2 pkp
28/05/15 First release 5.4 pkp 28/01/16 Modified the sleep API to configure Time
Stamp generator only when disable using frequency from xparamters.h instead of
hardcoding 5.05 pkp 13/04/16 Modified sleep routine to call XTime_StartTimer
which enables timer only when it is disabled and read counter value directly
from register instead of calling XTime_GetTime for optimization 6.0 mus 08/18/16
Updated the sleep signature. Fix for CR956899 6.6 srm 10/18/17 Updated sleep
routines to support user configurable implementation. Now sleep routines will
use Timer specified by the user (i.e. Global timer/TTC timer) </pre> Include
Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/sleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file usleep.c This function provides
a microsecond delay using the Generic counter register in the ARM Cortex A53
MPcore. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------- --------
5.2 pkp 28/05/15 First release 5.4 pkp 28/01/16 Modified the usleep API to
configure Time Stamp generator only when disable using frequency from
xparamters.h instead of hardcoding 5.05 pkp 13/04/16 Modified usleep routine to
call XTime_StartTimer which enables timer only when it is disabled and read
counter value directly from register instead of calling XTime_GetTime for
optimization 6.0 mus 08/18/16 Updated the usleep signature. Fix for CR956899 6.6
srm 10/18/17 Updated sleep routines to support user configurable implementation.
Now sleep routines will use Timer specified by the user (i.e. Global timer/TTC
timer) Include Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/usleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xil_cache.c Contains required
functions for the ARM cache functionality. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 5.2 pkp 28/05/15 First release 5.5 pkp 04/15/16
Updated the Xil_DCacheInvalidate, Xil_DCacheInvalidateLine and
Xil_DCacheInvalidateRange functions description for proper explanation 6.8 aru
06/15/18 Removed unused variables. 6.8 aru 07/04/18 Optimized code in
Xil_DCacheInvalidate and Xil_DCacheFlush 6.8 asa 11/10/18 Fix issues in cache
Xil_DCacheInvalidate and Xil_DCacheFlush that got introduced in the optimization
changes done in the previous patch for this file. /

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xil_cache.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.h @addtogroup
a53_32_cache_apis Cortex A53 32bit Processor Cache Functions Cache functions
provide access to cache related operations such as flush and invalidate for
instruction and data caches. It gives option to perform the cache operations on
a single cacheline, a range of memory and an entire cache. @{ <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 5.2 pkp 28/05/15 First release
</pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xil_cache.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache_l.h Contains L1 and
L2 specific functions for the ARM cache functionality used by xcache.c. This
functionality is being made available here for more sophisticated users. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm
01/24/10 First release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xil_cache_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.c This file provides
APIs for enabling/disabling MMU and setting the memory attributes for sections,
in the MMU translation table. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 5.2 pkp 28/05/15 First release </pre> @note None. Include
Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xil_mmu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.h @addtogroup
a53_32_mmu_apis Cortex A53 32bit Processor MMU Handling @{ MMU functions equip
users to enable MMU, disable MMU and modify default memory attributes of MMU
table as per the need. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 5.2 pkp 28/05/15 First release 7.1 mus 30/07/19 Added constant
definitions for memory attributes. </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xil_mmu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_ps.h This file
contains the address definitions for the hard peripherals attached to the ARM
Cortex A53 core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------
-------- 5.2 pkp 28/05/15 First release 6.0 mus 18/08/16 Defined ARMA53_32 flag
</pre> @note None.

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/platform/ZynqMP/xparameters_ps.h
lib/bsp/standalone/src/arm/ARMv8/32bit/xparameters_ps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm.h @addtogroup
a53_32_specific Cortex A53 32bit Processor Specific Include Files The
xpseudo_asm.h includes xreg_cortexa53.h and xpseudo_asm_gcc.h. The
xreg_cortexa53.h file contains definitions for inline assembler code. It
provides inline definitions for Cortex A53 GPRs, SPRs, co-processor registers
and floating point registers. The xpseudo_asm_gcc.h contains the definitions for
the most often used inline assembler instructions, available as macros. These
can be very useful for tasks such as setting or getting special purpose
registers, synchronization, or cache manipulation etc. These inline assembler
instructions can be used from drivers and user applications written in C. @{
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.2 pkp
28/05/15 First release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xpseudo_asm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xreg_cortexa53.h This header
file contains definitions for using inline assembler code. It is written
specifically for the GNU. All of the ARM Cortex A53 GPRs, SPRs, and Debug
Registers are defined along with the positions of the bits within the registers.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------- -------- 5.2 pkp
28/05/15 First release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xreg_cortexa53.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.c This file contains
low level functions to get/set time from the Generic Counter register in the ARM
Cortex A53 MPcore. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 5.2 pkp 28/05/15 First release 5.5 pkp 04/13/16 Added XTime_StartTimer
API to start the global timer counter if it is disabled. Also XTime_GetTime
calls this API to ensure the global timer counter is enabled </pre> @note None.
Include Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xtime_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.h @addtogroup
a53_32_time_apis Cortex A53 32bit Mode Time Functions xtime_l.h provides access
to the 64-bit physical timer counter. @{ <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 5.2 pkp 28/05/15 First release 6.6 srm
10/23/17 Updated the macros to support user configurable sleep implementation
</pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/xtime_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_ps.h This file
contains the address definitions for the hard peripherals attached to the ARM
Cortex A72 core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------
-------- 7.00 mus 01/11/18 First release mn 03/26/18 Change Interrupt IDs for
versal mn 03/26/18 Update SLCR base address </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/ARMv8/32bit/platform/versal/xparameters_ps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sleep.c This function provides
a second delay using the Global Timer register in the ARM Cortex A53 MP core.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------- -------- 5.00
pkp 05/29/14 First release 5.04 pkp 28/01/16 Modified the sleep API to configure
Time Stamp generator only when disable using frequency from xparamters.h instead
of hardcoding 5.05 pkp 13/04/16 Modified sleep routine to call XTime_StartTimer
which enables timer only when it is disabled and read counter value directly
from register instead of calling XTime_GetTime for optimization 6.0 asa 08/15/16
Updated the sleep/usleep signature. Fix for CR956899. 6.6 srm 10/18/17 Updated
sleep routines to support user configurable implementation. Now sleep routines
will use Timer specified by the user (i.e. Global timer/TTC timer) srm 01/11/18
Fixed the compilation warning. </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/sleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.c Contains required
functions for the ARM cache functionality. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 5.0 pkp 05/29/14 First release 5.5 pkp 04/15/16
Updated the Xil_DCacheInvalidate, Xil_DCacheInvalidateLine and
Xil_DCacheInvalidateRange functions description for proper explanation 6.2 pkp
01/22/17 Added support for EL1 non-secure 6.2 asa 01/31/17 The existing
Xil_DCacheDisable API first flushes the D caches and then disables it. The
problem with that is, potentially there will be a small window after the cache
flush operation and before the we disable D caches where we might have valid
data in cache lines. In such a scenario disabling the D cache can lead to
unknown behavior. The ideal solution to this is to use assembly code for the
complete API and avoid any memory accesses. But with that we will end up having
a huge amount on assembly code which is not maintainable. Changes are done to
use a mix of assembly and C code. All local variables are put in registers. Also
function calls are avoided in the API to avoid using stack memory. These changes
fix CR966220. 6.2 mus 02/13/17 The new api Xil_ConfigureL1Prefetch is added to
disable pre-fetching/configure the maximum number of outstanding data prefetches
allowed in L1 cache system.It fixes CR967864. 6.6 mus 02/27/18 Updated
Xil_DCacheInvalidateRange and Xil_ICacheInvalidateRange APIs to change the data
type of "cacheline" variable as "INTPTR", This change has been done to avoid the
truncation of upper DDR addresses to 32 bit.It fixes CR995581. 6.6 mus 03/15/18
By default CPUACTLR_EL1 is accessible only from EL3, it results into abort if
accessed from EL1 non secure privilege level. Updated Xil_ConfigureL1Prefetch
function to access CPUACTLR_EL1 only for EL3. 6.8 mn 08/01/18 Optimize the
Xil_DCacheInvalidateRange() function to remove redundant operations 6.8 asa
09/15/18 Fix bug in the Xil_DCacheInvalidateRange API introduced while making
optimizations in the previous patch. This change fixes CR-1008926. 7.0 mus
10/12/18 Updated Xil_DCacheInvalidateLine and Xil_DCacheInvalidateRange APIs to
replace IVAC instruction with CIVAC. So that, these APIs will always do flush +
invalidate in case of Cortexa53 as well as Cortexa72 processor. </pre> Include
Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xil_cache.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.h @addtogroup
a53_64_cache_apis Cortex A53 64bit Processor Cache Functions Cache functions
provide access to cache related operations such as flush and invalidate for
instruction and data caches. It gives option to perform the cache operations on
a single cacheline, a range of memory and an entire cache. @{ <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 5.00 pkp 05/29/14 First
release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xil_cache.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_errata.h @addtogroup
a53_errata Cortex A53 64 bit Processor Errata Support @{ Various ARM errata are
handled in the standalone BSP. The implementation for errata handling follows
ARM guidelines and is based on the open source Linux support for these errata.
@note The errata handling is enabled by default. To disable handling of all the
errata globally, un-define the macro ENABLE_ARM_ERRATA in xil_errata.h. To
disable errata on a per-erratum basis, un-define relevant macros in
xil_errata.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 6.4 mus 08/11/17 First release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xil_errata.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.c This file provides
APIs for enabling/disabling MMU and setting the memory attributes for sections,
in the MMU translation table. MMU APIs are yet to be implemented. They are left
blank to avoid any compilation error <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 5.00 pkp 05/29/14 First release 6.02 pkp 01/22/17
Added support for EL1 non-secure </pre> @note None. Include Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xil_mmu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.h @addtogroup
a53_64_mmu_apis Cortex A53 64bit Processor MMU Handling MMU function equip users
to modify default memory attributes of MMU table as per the need. @{ <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.00 pkp 05/29/14
First release </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xil_mmu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_smc.c This file contains
function for initiating SMC call <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- -------- -------- 6.2 pkp 02/16/17 First release </pre> Include
Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xil_smc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_smc.h @addtogroup
a53_64_smc_api Cortex A53 64bit EL1 Non-secure SMC Call Cortex A53 64bit EL1
Non-secure SMC Call provides a C wrapper for calling SMC from EL1 Non-secure
application to request Secure monitor for secure services. SMC calling
conventions should be followed. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- -------- -------- 6.2 pkp 02/16/17 First release 6.4 mus 08/17/17 Added
constant define for SMC ID , which is intended to read the version/idcode of the
platform 7.1 mus 07/31/19 Added support for Versal </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xil_smc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm.h @addtogroup
a53_64_specific Cortex A53 64bit Processor Specific Include Files The
xpseudo_asm.h includes xreg_cortexa53.h and xpseudo_asm_gcc.h. The
xreg_cortexa53.h file contains definitions for inline assembler code. It
provides inline definitions for Cortex A53 GPRs, SPRs and floating point
registers. The xpseudo_asm_gcc.h contains the definitions for the most often
used inline assembler instructions, available as macros. These can be very
useful for tasks such as setting or getting special purpose registers,
synchronization, or cache manipulation etc. These inline assembler instructions
can be used from drivers and user applications written in C. @{ <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.00 pkp 05/29/14
First release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xpseudo_asm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xreg_cortexa53.h This header
file contains definitions for using inline assembler code. It is written
specifically for the GNU compiler. All of the ARM Cortex A53 GPRs, SPRs, and
Debug Registers are defined along with the positions of the bits within the
registers. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --------
-------- 5.00 pkp 05/29/14 First release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xreg_cortexa53.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.c This file contains
low level functions to get/set time from the Global Timer register in the ARM
Cortex A53 MP core. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------ -------- 5.00 pkp 05/29/14 First release 5.05 pkp 04/13/16 Added
XTime_StartTimer API to start the global timer counter if it is disabled. Also
XTime_GetTime calls this API to ensure the global timer counter is enabled 6.02
pkp 01/22/17 Added support for EL1 non-secure </pre> @note None. Include Files /

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xtime_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.h @addtogroup
a53_64_time_apis Cortex A53 64bit Mode Time Functions xtime_l.h provides access
to the 64-bit physical timer counter. @{ <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 5.00 pkp 05/29/14 First release 6.6 srm
10/23/17 Updated the macros to support user configurable sleep implementation
</pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xtime_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm_armclang.h This
header file contains macros for using __inline assembler code. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 7.0 cjp 02/26/19
First Release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/armclang/xpseudo_asm_armclang.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file initialise_monitor_handles.c
Contains blank function to avoid compilation error @note <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- -------- -------- 5.00 pkp 05/29/14 First
release </pre>

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/gcc/initialise_monitor_handles.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_ps.h This file
contains the address definitions for the hard peripherals attached to the ARM
Cortex A53 core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------
-------- 5.00 pkp 05/29/14 First release </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/platform/ZynqMP/xparameters_ps.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/a53/xparameters_ps.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102/a53/xparameters_ps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_ps.h This file
contains the address definitions for the hard peripherals attached to the ARM
Cortex A72 core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------
-------- 7.00 mus 01/11/18 First release mn 03/26/18 Change Interrupt IDs for
versal mn 03/26/18 Update SLCR base address ap 02/14/19 Add Interrupt Id for
usbpsu controller </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/platform/versal/xparameters_ps.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

Copyright DornerWorks 2016 Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. THIS
SOFTWARE IS PROVIDED BY DORNERWORKS FOR USE ON THE CONTRACTED PROJECT, AND ANY
EXPRESS OR IMPLIED WARRANTY IS LIMITED TO THIS USE. FOR ALL OTHER USES THIS
SOFTWARE IS PROVIDED ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DORNERWORKS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xpvxenconsole/arm64_ops.h
lib/bsp/standalone/src/arm/ARMv8/64bit/xpvxenconsole/hypercall.h
lib/bsp/standalone/src/arm/ARMv8/64bit/xpvxenconsole/xen_events.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

xen.h Guest OS interface to Xen. Permission is hereby granted, free of charge,
to any person obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Copyright (c) 2004, K A Fraser /
Copyright DornerWorks 2016 Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. THIS
SOFTWARE IS PROVIDED BY DORNERWORKS FOR USE ON THE CONTRACTED PROJECT, AND ANY
EXPRESS OR IMPLIED WARRANTY IS LIMITED TO THIS USE. FOR ALL OTHER USES THIS
SOFTWARE IS PROVIDED ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DORNERWORKS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xpvxenconsole/xen.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

(C) 2006 - Grzegorz Milos - Cambridge University File: console.h Author:
Grzegorz Milos Changes: Date: Mar 2006 Environment: Xen Minimal OS Description:
Console interface. Handles console I/O. Defines printk. Permission is hereby
granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the
following conditions: The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. /
Copyright DornerWorks 2016 Redistribution and use in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met: 1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following disclaimer. THIS
SOFTWARE IS PROVIDED BY DORNERWORKS FOR USE ON THE CONTRACTED PROJECT, AND ANY
EXPRESS OR IMPLIED WARRANTY IS LIMITED TO THIS USE. FOR ALL OTHER USES THIS
SOFTWARE IS PROVIDED ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DORNERWORKS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xpvxenconsole/xen_console.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

xen_console.h Created on: Sep 14, 2016 Author: jarvis / Copyright DornerWorks
2016 Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. THIS SOFTWARE IS PROVIDED BY
DORNERWORKS FOR USE ON THE CONTRACTED PROJECT, AND ANY EXPRESS OR IMPLIED
WARRANTY IS LIMITED TO THIS USE. FOR ALL OTHER USES THIS SOFTWARE IS PROVIDED
''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL DORNERWORKS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xpvxenconsole/xen_console.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

xen_events.h Created on: Sep 14, 2016 Author: jarvis / Copyright DornerWorks
2016 Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 1.
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. THIS SOFTWARE IS PROVIDED BY
DORNERWORKS FOR USE ON THE CONTRACTED PROJECT, AND ANY EXPRESS OR IMPLIED
WARRANTY IS LIMITED TO THIS USE. FOR ALL OTHER USES THIS SOFTWARE IS PROVIDED
''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL DORNERWORKS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FILES:
lib/bsp/standalone/src/arm/ARMv8/64bit/xpvxenconsole/xen_events.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

putnum.c -- put a hex number on the output device. Copyright (c) 1995 Cygnus
Support The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided that
existing copyright notices are retained in all copies and that this notice is
included verbatim in any distributions. No written agreement, license, or
royalty fee is required for any of the authorized uses. Modifications to this
software may be copyrighted by their authors and need not follow the licensing
terms described here, provided that the new terms are clearly indicated on the
first page of each file where they apply. / putnum -- print a 32 bit number in
hex / Include Files /

FILES:
lib/bsp/standalone/src/arm/common/putnum.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file vectors.c This file contains
the C level vectors for the ARM Cortex A9 core. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a ecm 10/20/09 Initial version, moved
over from bsp area 6.0 mus 27/07/16 Consolidated vectors for a53,a9 and r5
processor and added UndefinedException for a53 32 bit and r5 processor </pre>
@note None. Include Files /

FILES:
lib/bsp/standalone/src/arm/common/vectors.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file vectors.h This file contains
the C level vector prototypes for the ARM Cortex A9 core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm 10/20/10 Initial
version, moved over from bsp area 6.0 mus 07/27/16 Consolidated vectors for
a9,a53 and r5 processors </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/common/vectors.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_exception.c This file
contains low-level driver functions for the Cortex A53,A9,R5 exception Handler.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------- -------- 5.2 pkp
28/05/15 First release 6.0 mus 27/07/16 Consolidated exceptions for a53,a9 and
r5 processors and added Xil_UndefinedExceptionHandler for a53 32 bit and r5 as
well. 6.4 mus 08/06/17 Updated debug prints to replace %x with the %lx, to fix
the warnings. 6.7 mna 26/04/18 Add an API to obtain a corresponding
Xil_ExceptionHandler entry from XExc_VectorTable. 6.7 asa 18/05/18 Fix bugs in
the API Xil_GetExceptionRegisterHandler. 7.0 mus 07/03/19 Tweak
Xil_ExceptionRegisterHandler and Xil_GetExceptionRegisterHandler to support
legacy examples for Cortexa72 EL3 exception level. </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/common/xil_exception.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_exception.h This header
file contains ARM Cortex A53,A9,R5 specific exception related APIs. For
exception related functions that can be used across all Xilinx supported
processors, please use xil_exception.h. @addtogroup arm_exception_apis ARM
Processor Exception Handling @{ ARM processors specific exception related APIs
for cortex A53,A9 and R5 can utilized for enabling/disabling IRQ,
registering/removing handler for exceptions or initializing exception vector
table with null handler. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
-------- -------- 5.2 pkp 28/05/15 First release 6.0 mus 27/07/16 Consolidated
file for a53,a9 and r5 processors 6.7 mna 26/04/18 Add API
Xil_GetExceptionRegisterHandler. 6.7 asa 18/05/18 Update signature of API
Xil_GetExceptionRegisterHandler. 7.0 mus 01/03/19 Tweak Xil_ExceptionEnableMask
and Xil_ExceptionDisableMask macros to support legacy examples for Cortexa72 EL3
exception level. </pre>

FILES:
lib/bsp/standalone/src/arm/common/xil_exception.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_sleeptimer.c This file
provides the common helper routines for the sleep API's <pre> MODIFICATION
HISTORY : Ver Who Date Changes ----- ---- -------- 6.6 srm 10/18/17 First
Release. 6.6 srm 04/20/18 Fixed compilation warning in Xil_SleepTTCCommon API
7.0 mus 03/27/19 Updated XTime_StartTTCTimer to skip IOU slcr address space
access, if processor is nonsecure and IOU slcr address space is secure.
CR1015725. </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/common/xil_sleeptimer.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_sleeptimer.h This header
file contains ARM Cortex A53,A9,R5 specific sleep related APIs. For sleep
related functions that can be used across all Xilinx supported processors,
please use xil_sleeptimer.h. <pre> MODIFICATION HISTORY : Ver Who Date Changes
----- ---- -------- 6.6 srm 10/18/17 First Release. 7.0 mus 01/07/19 Add cpp
extern macro </pre>

FILES:
lib/bsp/standalone/src/arm/common/xil_sleeptimer.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. The errno variable is stored in the
reentrancy structure. This function returns its address for use by the macro
errno defined in errno.h. /

FILES:
lib/bsp/standalone/src/arm/common/gcc/errno.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. read.c -- read bytes from a input
device. /

FILES:
lib/bsp/standalone/src/arm/common/gcc/read.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. write.c -- write bytes to an output
device. /

FILES:
lib/bsp/standalone/src/arm/common/gcc/write.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm_gcc.h This header
file contains macros for using inline assembler code. It is written specifically
for the GNU compiler. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
-------- -------- 5.00 pkp 05/21/14 First release 6.0 mus 07/27/16 Consolidated
file for a53,a9 and r5 processors </pre>

FILES:
lib/bsp/standalone/src/arm/common/gcc/xpseudo_asm_gcc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. This is the default implementation of
the "clock" function of the standard library. It can be replaced with a system-
specific implementation. The "clock" function should return the processor time
used by the program from some implementation-defined start time. The value
should be such that if divided by the macro CLOCKS_PER_SEC the result should
yield the time in seconds. The value "(clock_t)-1" means that the processor time
is not available. /

FILES:
lib/bsp/standalone/src/arm/common/iccarm/clock.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. This module contains the function
`__low_level_init', a function that is called before the `main' function of the
program. Normally low-level initializations - such as setting the preferred
interrupt level or setting the watchdog - can be performed here. Note that this
function is called before the data segments are initialized, this means that
this function cannot rely on the values of global or static variables. When this
function returns zero, the startup code will inhibit the initialization of the
data segments. The result is faster startup, the drawback is that neither global
nor static data will be initialized. /

FILES:
lib/bsp/standalone/src/arm/common/iccarm/low_level_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. This is a template implementation of
the "__lseek" function used by the standard library. Replace it with a system-
specific implementation. The "__lseek" function makes the next file operation
(__read or __write) act on a new location. The parameter "whence" specifies how
the "offset" parameter should be interpreted according to the following table: 0
(SEEK_SET) - Goto location "offset". 1 (SEEK_CUR) - Go "offset" bytes from the
current location. 2 (SEEK_END) - Go to "offset" bytes from the end. This
function should return the current file position, or -1 on failure. /

FILES:
lib/bsp/standalone/src/arm/common/iccarm/lseek.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. This is a template implementation of
the "__open" function used by the standard library. Replace it with a system-
specific implementation. The "__open" function opens the file named "filename"
as specified by "mode". open -- open a file descriptor. We don't have a
filesystem, so we return an error. /

FILES:
lib/bsp/standalone/src/arm/common/iccarm/open.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. The "__read" function reads a number
of bytes, at most "size" into the memory area pointed to by "buffer". It returns
the number of bytes read, 0 at the end of the file, or _LLIO_ERROR if failure
occurs. The template implementation below should return a character value, or -1
on failure. /

FILES:
lib/bsp/standalone/src/arm/common/iccarm/read.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. The "remove" function should remove
the file named "filename". It should return 0 on success and nonzero on failure.
/

FILES:
lib/bsp/standalone/src/arm/common/iccarm/remove.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. The "__write" function should output
"size" number of bytes from "buffer" in some application-specific way. It should
return the number of characters written, or _LLIO_ERROR on failure. If "buffer"
is zero then __write should perform flushing of internal buffers, if any. In
this case "handle" can be -1 to indicate that all handles should be flushed. The
template implementation below assumes that the application provides the function
"MyLowLevelPutchar". It should return the character written, or -1 on failure. /

FILES:
lib/bsp/standalone/src/arm/common/iccarm/write.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm_iccarm.c This file
contains functions for ARM register handling. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 3.12a asa 11/2/13 First Release </pre>
Include Files /

FILES:
lib/bsp/standalone/src/arm/common/iccarm/xpseudo_asm_iccarm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm_iccarm.h This
header file contains macros for using inline assembler code. It is written
specifically for the IAR C/C++ compiler. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- -------- -------- 1.00a ecm/sdm 10/28/09 First release 3.12a
asa 11/02/13 Removed the macro mfcpsr to make it a function. 5.3 pkp 10/09/15
Modified dsb, dmb and isb definitions 5.4 pkp 03/02/16 Included header file
intrinsic.h for assembly instructions definitions 6.2 kvn 03/03/17 Added support
thumb mode </pre>

FILES:
lib/bsp/standalone/src/arm/common/iccarm/xpseudo_asm_iccarm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sleep.c This function provides
a second delay using the Global Timer register in the ARM Cortex A9 MP core.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------- -------- 1.00a
ecm/sdm 11/11/09 First release 3.07a sgd 07/05/12 Updated sleep function to make
use Global 6.0 asa 08/15/16 Updated the sleep signature. Fix for CR956899. 6.6
srm 10/18/17 Updated sleep routines to support user configurable implementation.
Now sleep routines will use Timer specified by the user (i.e. Global timer/TTC
timer) </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/sleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file smc.h <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sdm 11/03/09 Initial
release. 4.2 pkp 08/04/14 Removed function definition of XSmc_NorInit and
XSmc_NorInit as smc.c is removed </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/cortexa9/smc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file usleep.c This function provides
a microsecond delay using the Global Timer register in the ARM Cortex A9 MP
core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------- --------
1.00a ecm/sdm 11/11/09 First release 3.07a sgd 07/05/12 Updated micro sleep
function to make use Global Timer 4.2 pkp 08/04/14 Removed unimplemented
nanosleep routine as it is not possible to generate timer in nanosecond due to
limited cpu frequency 6.0 asa 08/15/16 Updated the usleep signature. Fix for
CR956899. 6.6 srm 10/18/17 Updated sleep routines to support user configurable
implementation. Now sleep routines will use Timer specified by the user (i.e.
Global timer/TTC timer) </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/usleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.c Contains required
functions for the ARM cache functionality. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a ecm 01/29/10 First release 1.00a ecm
06/24/10 Moved the L1 and L2 specific function prototypes to xil_cache_mach.h to
give access to sophisticated users 3.02a sdm 04/07/11 Updated
Flush/InvalidateRange APIs to flush/invalidate L1 and L2 caches in a single loop
and used dsb, L2 sync at the end of the loop. 3.04a sdm 01/02/12 Remove
redundant dsb/dmb instructions in cache maintenance APIs. 3.07a asa 07/16/12
Corrected the L1 and L2 cache invalidation order. 3.07a sgd 09/18/12 Corrected
the L2 cache enable and disable sequence. 3.10a srt 04/18/13 Implemented ARM
Erratas. Please refer to file 'xil_errata.h' for errata description 3.10a asa
05/13/13 Modified cache disable APIs. The L2 cache disable operation was being
done with L1 Data cache disabled. This is fixed so that L2 cache disable
operation happens independent of L1 cache disable operation. This fixes CR
706464. Changes are done to do a L2 cache sync (poll reg7_?cache_?sync). This is
done to fix the CR 700542. 3.11a asa 09/23/13 Modified the Xil_DCacheFlushRange
and Xil_DCacheInvalidateRange to fix potential issues. Fixed other relevant
cache APIs to disable and enable back the interrupts. This fixes CR 663885.
3.11a asa 09/28/13 Made changes for L2 cache sync operation. It is found out
that for L2 cache flush/clean/invalidation by cache lines does not need a cache
sync as these are atomic nature. Similarly figured out that for complete L2
cache flush/invalidation by way we need to wait for some more time in a loop
till the status shows that the cache operation is completed. 4.00 pkp 24/01/14
Modified Xil_DCacheInvalidateRange to fix the bug. Few cache lines were missed
to invalidate when unaligned address invalidation was accommodated. That fixes
CR 766768. Also in Xil_L1DCacheInvalidate, while invalidating all L1D cache
stack memory which contains return address was invalidated. So stack memory was
flushed first and then L1D cache is invalidated. This is done to fix CR 763829
4.01 asa 05/09/14 Made changes in cortexa9/xil_cache.c to fix CR 798230. 4.02
pkp 06/27/14 Added notes to Xil_L1DCacheInvalidateRange function for explanation
of CR785243 5.00 kvn 12/15/14 Xil_L2CacheInvalidate was modified to fix CR
838835. L2 Cache has stack memory which has return address. Before invalidating
cache, stack memory was flushed first and L2 Cache is invalidated. 5.01 pkp
05/12/15 Xil_DCacheInvalidateRange and Xil_DCacheFlushRange is modified to
remove unnecessary dsb in the APIs. Instead of using dsb for L2 Cache,
L2CacheSync has been used for each L2 cache line and single dsb has been used
for L1 cache. Also L2CacheSync is added into Xil_L2CacheInvalidateRange API.
Xil_L1DCacheInvalidate and Xil_L2CacheInvalidate APIs are modified to flush the
complete stack instead of just System Stack 5.03 pkp 10/07/15 L2 Cache
functionalities are avoided for the OpenAMP slave application(when USE_AMP flag
is defined for BSP) as master CPU would be utilizing L2 cache for its operation
6.6 mus 12/07/17 Errata 753970 is not applicable for the PL130 cache controller
version r0p2, which is present in zynq. So,removed the handling related to
same.It fixes CR989132. 6.6 asa 16/01/18 Changes made in Xil_L1DCacheInvalidate
and Xil_L2CacheInvalidate routines to ensure the stack data flushed only when
the respective caches are enabled. This fixes CR-992023. </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_cache.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.h @addtogroup
a9_cache_apis Cortex A9 Processor Cache Functions Cache functions provide access
to cache related operations such as flush and invalidate for instruction and
data caches. It gives option to perform the cache operations on a single
cacheline, a range of memory and an entire cache. @{ <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a ecm 01/29/10 First release 3.04a
sdm 01/02/12 Remove redundant dsb/dmb instructions in cache maintenance APIs.
6.8 aru 09/06/18 Removed compilation warnings for ARMCC toolchain. </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_cache.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache_l.h Contains L1 and
L2 specific functions for the ARM cache functionality used by xcache.c. This
functionality is being made available here for more sophisticated users.
@addtogroup a9_cache_apis @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a ecm 01/24/10 First release 6.8 aru 09/06/18 Removed
compilation warnings for ARMCC toolchain. </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_cache_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_errata.h @addtogroup
a9_errata Cortex A9 Processor and pl310 Errata Support @{ Various ARM errata are
handled in the standalone BSP. The implementation for errata handling follows
ARM guidelines and is based on the open source Linux support for these errata.
@note The errata handling is enabled by default. To disable handling of all the
errata globally, un-define the macro ENABLE_ARM_ERRATA in xil_errata.h. To
disable errata on a per-erratum basis, un-define relevant macros in
xil_errata.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a srt 04/18/13 First release 6.6 mus 12/07/17 Removed errata
753970, It fixes CR989132. </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_errata.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_misc_reset.c This file
contains the implementation of the reset sequence for various zynq ps devices
like DDR,OCM,Slcr,Ethernet,Usb.. controllers. The reset sequence provided to the
interfaces is based on the provision in slcr reset functional block. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b kpc
03/07/13 First release 5.4 pkp 09/11/15 Change the description for XOcm_Remap
function </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_misc_psreset_api.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_misc_psreset_api.h This
file contains the various register definitions and function prototypes for
implementing the reset functionality of zynq ps devices MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00b kpc 03/07/13 First release.
</pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_misc_psreset_api.h
lib/bsp/standalone/src/microblaze/xil_misc_psreset_api.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.c This file provides
APIs for enabling/disabling MMU and setting the memory attributes for sections,
in the MMU translation table. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a sdm 01/12/12 Initial version 3.05a asa 03/10/12
Modified the Xil_EnableMMU to invalidate the caches before enabling back. 3.05a
asa 04/15/12 Modified the Xil_SetTlbAttributes routine so that translation table
and branch predictor arrays are invalidated, D-cache flushed before the
attribute change is applied. This is done so that the user need not call
Xil_DisableMMU before calling Xil_SetTlbAttributes. 3.10a srt 04/18/13
Implemented ARM Erratas. Please refer to file 'xil_errata.h' for errata
description 3.11a asa 09/23/13 Modified Xil_SetTlbAttributes to flush the
complete D cache after the translation table update. Removed the redundant TLB
invalidation in the same API at the beginning. 6.8 aru 09/06/18 Removed
compilation warnings for ARMCC toolchain. It fixes CR1008309. </pre> @note None.
Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_mmu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.h @addtogroup
a9_mmu_apis Cortex A9 Processor MMU Functions MMU functions equip users to
enable MMU, disable MMU and modify default memory attributes of MMU table as per
the need. @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sdm 01/12/12 Initial version 4.2 pkp 07/21/14 Included
xil_types.h file which contains definition for u32 which resolves issue of
CR805869 5.4 pkp 23/11/15 Added attribute definitions for Xil_SetTlbAttributes
API 6.8 aru 09/06/18 Removed compilation warnings for ARMCC toolchain. </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xil_mmu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xl2cc.h This file contains the
address definitions for the PL310 Level-2 Cache Controller. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sdm 02/01/10 Initial
version 3.10a srt 04/18/13 Implemented ARM Erratas. Please refer to file
'xil_errata.h' for errata description </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/cortexa9/xl2cc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xl2cc_counter.c This file
contains APIs for configuring and controlling the event counters in PL310 L2
cache controller. For more information about the event counters, see
xl2cc_counter.h. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a sdm 07/11/11 First release 3.07a asa 08/30/12 Updated for CR
675636 to provide the L2 Base Address inside the APIs </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/xl2cc_counter.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xl2cc_counter.h @addtogroup
l2_event_counter_apis PL310 L2 Event Counters Functions xl2cc_counter.h contains
APIs for configuring and controlling the event counters in PL310 L2 cache
controller. PL310 has two event counters which can be used to count variety of
events like DRHIT, DRREQ, DWHIT, DWREQ, etc. xl2cc_counter.h contains
definitions for different configurations which can be used for the event
counters to count a set of events. @{ <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a sdm 07/11/11 First release 3.07a asa 08/30/12
Updated for CR 675636 to provide the L2 Base Address inside the APIs 6.8 aru
09/06/18 Removed compilation warnings for ARMCC toolchain. </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xl2cc_counter.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_ps.h This file
contains the address definitions for the hard peripherals attached to the ARM
Cortex A9 core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- -------
-------- 1.00a ecm/sdm 02/01/10 Initial version 3.04a sdm 02/02/12 Removed some
of the defines as they are being generated through driver tcl 5.0 pkp 01/16/15
Added interrupt ID definition of ttc for TEST APP 6.6 srm 10/18/17 Added ARMA9
macro to identify CortexA9 </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/cortexa9/xparameters_ps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpm_counter.c This file
contains APIs for configuring and controlling the Cortex-A9 Performance Monitor
Events. For more information about the event counters, see xpm_counter.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sdm
07/11/11 First release 4.2 pkp 07/21/14 Corrected reset value of event counter
in function Xpm_ResetEventCounters to fix CR796275 </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/xpm_counter.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpm_counter.h @addtogroup
a9_event_counter_apis Cortex A9 Event Counters Functions Cortex A9 event counter
functions can be utilized to configure and control the Cortex-A9 performance
monitor events. Cortex-A9 performance monitor has six event counters which can
be used to count a variety of events described in Coretx-A9 TRM. xpm_counter.h
defines configurations XPM_CNTRCFGx which can be used to program the event
counters to count a set of events. @note It doesn't handle the Cortex-A9 cycle
counter, as the cycle counter is being used for time keeping. @{ <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sdm
07/11/11 First release 6.8 aru 09/06/18 Removed compilation warnings for ARMCC
toolchain. </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xpm_counter.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm.h @addtogroup
a9_specific Cortex A9 Processor Specific Include Files The xpseudo_asm.h
includes xreg_cortexa9.h and xpseudo_asm_gcc.h. The xreg_cortexa9.h file
contains definitions for inline assembler code. It provides inline definitions
for Cortex A9 GPRs, SPRs, MPE registers, co-processor registers and Debug
registers. The xpseudo_asm_gcc.h contains the definitions for the most often
used inline assembler instructions, available as macros. These can be very
useful for tasks such as setting or getting special purpose registers,
synchronization, or cache manipulation etc. These inline assembler instructions
can be used from drivers and user applications written in C. @{ <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ecm
10/18/09 First release 3.04a sdm 01/02/12 Remove redundant dsb in mcr
instruction. 6.8 aru 09/06/18 Removed compilation warnings for ARMCC toolchain.
</pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xpseudo_asm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xreg_cortexa9.h This header
file contains definitions for using inline assembler code. It is written
specifically for the GNU, ARMCC compiler. All of the ARM Cortex A9 GPRs, SPRs,
and Debug Registers are defined along with the positions of the bits within the
registers. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --------
-------- 1.00a ecm/sdm 10/20/09 First release </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xreg_cortexa9.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.c This file contains
low level functions to get/set time from the Global Timer register in the ARM
Cortex A9 MP core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 1.00a rp/sdm 11/03/09 Initial release. 3.07a sgd 07/05/12 Updated
get/set time functions to make use Global Timer </pre> @note None. Include Files
/

FILES:
lib/bsp/standalone/src/arm/cortexa9/xtime_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.h @addtogroup
a9_time_apis Cortex A9 Time Functions xtime_l.h provides access to the 64-bit
Global Counter in the PMU. This counter increases by one at every two processor
cycles. These functions can be used to get/set time in the global timer. @{
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.00a
rp/sdm 11/03/09 Initial release. 3.06a sgd 05/15/12 Updated get/set time
functions to make use Global Timer 3.06a asa 06/17/12 Reverted back the changes
to make use Global Timer. 3.07a sgd 07/05/12 Updated get/set time functions to
make use Global Timer 6.6 srm 10/23/17 Updated the macros to support user
configurable sleep implementation 6.8 aru 09/06/18 Removed compilation warnings
for ARMCC toolchain. </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/xtime_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm_rvct.c This header
file contains functions for using assembler code. It is written specifically for
RVCT. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
sdm 11/18/09 First Release </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexa9/armcc/xpseudo_asm_rvct.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm_rvct.h This header
file contains macros for using __inline assembler code. It is written
specifically for RVCT. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a sdm 11/18/09 First Release </pre>

FILES:
lib/bsp/standalone/src/arm/cortexa9/armcc/xpseudo_asm_rvct.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sleep.c This function supports
user configurable sleep implementation. This provides delay in seconds by using
the Timer specified by the user in the ARM Cortex R5 MP core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- -------- -------- 5.00 pkp 02/20/14 First
release 5.04 pkp 02/19/16 sleep routine is modified to use TTC3 if present else
it will use set of assembly instructions to provide the required delay 5.04 pkp
03/09/16 Assembly routine for sleep is modified to avoid disabling the interrupt
5.04 pkp 03/11/16 Compare the counter value to previously read value to detect
the overflow for TTC3 6.0 asa 08/15/16 Updated the sleep signature. Fix for
CR956899. 6.6 srm 10/18/17 Updated sleep routines to support user configurable
implementation. Now sleep routines will use TTC instance specified by user.
</pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/sleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file usleep.c This function supports
user configurable sleep implementation. This provides a microsecond delay using
the timer specified by the user in the ARM Cortex R5 MP core. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- -------- -------- 5.00 pkp 02/20/14 First
release 5.04 pkp 02/19/16 usleep routine is modified to use TTC3 if present else
it will use set of assembly instructions to provide the required delay 5.04 pkp
03/09/16 Assembly routine for usleep is modified to avoid disabling the
interrupt 5.04 pkp 03/11/16 Compare the counter value to previously read value
to detect the overflow for TTC3 6.0 asa 08/15/16 Updated the usleep signature.
Fix for CR956899. 6.6 srm 10/18/17 Updated sleep routines to support user
configurable implementation. Now sleep routines will use TTC instance specified
by user. </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/usleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.c Contains required
functions for the ARM cache functionality. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 5.00 pkp 02/20/14 First release 6.2 mus
01/27/17 Updated to support IAR compiler </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/xil_cache.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.h @addtogroup
r5_cache_apis Cortex R5 Processor Cache Functions Cache functions provide access
to cache related operations such as flush and invalidate for instruction and
data caches. It gives option to perform the cache operations on a single
cacheline, a range of memory and an entire cache. @{ <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 5.00 pkp 02/20/14 First release 6.2 mus
01/27/17 Updated to support IAR compiler </pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/xil_cache.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.h This file only
includes xil_mpu.h which contains Xil_SetTlbAttributes API defined for MPU in
R5. R5 does not have mmu and for usage of similar API the file has been created.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.0 pkp
2/12/15 Initial version </pre> @note None.

FILES:
lib/bsp/standalone/src/arm/cortexr5/xil_mmu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mpu.c This file provides
APIs for enabling/disabling MPU and setting the memory attributes for sections,
in the MPU translation table. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 5.00 pkp 02/10/14 Initial version 6.2 mus 01/27/17 Updated
to support IAR compiler 6.4 asa 08/16/17 Added many APIs for MPU access to make
MPU usage user-friendly. The APIs added are: Xil_UpdateMPUConfig,
Xil_GetMPUConfig, Xil_GetNumOfFreeRegions, Xil_GetNextMPURegion,
Xil_DisableMPURegionByRegNum, Xil_GetMPUFreeRegMask, Xil_SetMPURegionByRegNum,
and Xil_InitializeExistingMPURegConfig. Added a new array of structure of type
XMpuConfig to represent the MPU configuration table. 6.8 aru 07/02/18 Returned
the pointer instead of address of that pointer in Xil_MemMap(). </pre> Include
Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/xil_mpu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mmu.h @addtogroup
r5_mpu_apis Cortex R5 Processor MPU specific APIs MPU functions provides access
to MPU operations such as enable MPU, disable MPU and set attribute for section
of memory. Boot code invokes Init_MPU function to configure the MPU. A total of
10 MPU regions are allocated with another 6 being free for users. Overview of
the memory attributes for different MPU regions is as given below, | | Memory
Range | Attributes of MPURegion | |-----------------------|---------------------
----|-----------------------------| | DDR | 0x00000000 - 0x7FFFFFFF | Normal
write-back Cacheable | | PL | 0x80000000 - 0xBFFFFFFF | Strongly Ordered | |
QSPI | 0xC0000000 - 0xDFFFFFFF | Device Memory | | PCIe | 0xE0000000 -
0xEFFFFFFF | Device Memory | | STM_CORESIGHT | 0xF8000000 - 0xF8FFFFFF | Device
Memory | | RPU_R5_GIC | 0xF9000000 - 0xF90FFFFF | Device memory | | FPS |
0xFD000000 - 0xFDFFFFFF | Device Memory | | LPS | 0xFE000000 - 0xFFFFFFFF |
Device Memory | | OCM | 0xFFFC0000 - 0xFFFFFFFF | Normal write-back Cacheable |
@note For a system where DDR is less than 2GB, region after DDR and before PL is
marked as undefined in translation table. Memory range 0xFE000000-0xFEFFFFFF is
allocated for upper LPS slaves, where as memory region 0xFF000000-0xFFFFFFFF is
allocated for lower LPS slaves. @{ <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 5.00 pkp 02/10/14 Initial version 6.4 asa 08/16/17
Added many APIs for MPU access to make MPU usage user-friendly. The APIs added
are: Xil_UpdateMPUConfig, Xil_GetMPUConfig, Xil_GetNumOfFreeRegions,
Xil_GetNextMPURegion, Xil_DisableMPURegionByRegNum, Xil_GetMPUFreeRegMask,
Xil_SetMPURegionByRegNum, and Xil_InitializeExistingMPURegConfig. Added a new
array of structure of type XMpuConfig to represent the MPU configuration table.
</pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/xil_mpu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpm_counter.c This file
contains APIs for configuring and controlling the Cortex-R5 Performance Monitor
Events. For more information about the event counters, see xpm_counter.h. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.00 pkp 02/10/14
Initial version 6.2 mus 01/27/17 Updated to support IAR compiler 7.1 aru
04/15/19 Updated the events correctly </pre> Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/xpm_counter.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpm_counter.h @addtogroup
r5_event_counter_apis Cortex R5 Event Counters Functions Cortex R5 event counter
functions can be utilized to configure and control the Cortex-R5 performance
monitor events. Cortex-R5 Performance Monitor has 6 event counters which can be
used to count a variety of events described in Coretx-R5 TRM. The xpm_counter.h
file defines configurations XPM_CNTRCFGx which can be used to program the event
counters to count a set of events. @note It doesn't handle the Cortex-R5 cycle
counter, as the cycle counter is being used for time keeping. @{ <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.00 pkp 02/10/14
Initial version 7.1 aru 04/15/19 Updated the events correctly </pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/xpm_counter.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpseudo_asm.h @addtogroup
r5_specific Cortex R5 Processor Specific Include Files The xpseudo_asm.h
includes xreg_cortexr5.h and xpseudo_asm_gcc.h. The xreg_cortexr5.h file
contains definitions for inline assembler code. It provides inline definitions
for Cortex R5 GPRs, SPRs,co-processor registers and Debug register The
xpseudo_asm_gcc.h contains the definitions for the most often used inline
assembler instructions, available as macros. These can be very useful for tasks
such as setting or getting special purpose registers, synchronization,or cache
manipulation. These inline assembler instructions can be used from drivers and
user applications written in C. @{ <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 5.00 pkp 02/10/14 Initial version 6.2 mus 01/27/17
Updated to support IAR compiler </pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/xpseudo_asm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xreg_cortexr5.h This header
file contains definitions for using inline assembler code. It is written
specifically for the GNU, IAR, ARMCC compiler. All of the ARM Cortex R5 GPRs,
SPRs, and Debug Registers are defined along with the positions of the bits
within the registers. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
-------- -------- 5.00 pkp 02/10/14 Initial version </pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/xreg_cortexr5.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.c This file contains
low level functions to get/set time from the Global Timer register in the ARM
Cortex R5 core. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 5.00 pkp 08/29/14 First release 5.04 pkp 02/19/16 XTime_StartTimer API
is added to configure TTC3 timer when present. XTime_GetTime is modified to give
64bit output using timer overflow when TTC3 present. XTime_SetTime is modified
to configure TTC3 counter value when present. 5.04 pkp 03/11/16 XTime_StartTimer
is modified to avoid enabling the overflow interrupt and XTime_GetTime &
XTime_SetTime are modified to read and write TTC counter value respectively 5.04
pkp 6.0 mus 08/11/16 Removed implementation of XTime_SetTime API, since TTC
counter value register is read only. 6.6 srm 10/18/17 Removed XTime_StartTimer
API and made XTime_GetTime, XTime_SetTime applicable for all the instances of
TTC </pre> @note None. Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/xtime_l.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xtime_l.h @addtogroup
r5_time_apis Cortex R5 Time Functions The xtime_l.h provides access to 32-bit
TTC timer counter. These functions can be used by applications to track the
time. @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------ --------
5.00 pkp 05/29/14 First release 5.04 pkp 02/19/16 Added timer configuration
register offset definitions 5.04 pkp 03/11/16 Removed definitions for overflow
interrupt register and mask 6.6 srm 10/22/17 Added a warning message for the
user configurable sleep implementation when default timer is selected by the
user </pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/xtime_l.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mpu.c This file contains
initial configuration of the MPU. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 5.00 pkp 02/20/14 First release 5.04 pkp 12/18/15
Updated MPU initialization as per the proper address map 6.00 pkp 06/27/16
moving the Init_MPU code to .boot section since it is a part of processor boot
process 6.2 mus 01/27/17 Updated to support IAR compiler </pre> @note None.
Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/platform/ZynqMP/mpu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_ps.h @addtogroup
r5_peripheral_definitions Cortex R5 peripheral definitions The xparameters_ps.h
file contains the canonical definitions and constant declarations for
peripherals within hardblock, attached to the ARM Cortex R5 core. These
definitions can be used by drivers or applications to access the peripherals. @{
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 5.00 pkp
02/29/14 Initial version 6.0 mus 08/18/16 Defined ARMR5 flag </pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/platform/ZynqMP/xparameters_ps.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/r5/xparameters_ps.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102/r5/xparameters_ps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mpu.c This file contains
initial configuration of the MPU. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 7.00 mus 02/20/14 First release 7.00 mus 03/16/19
Updated MPU region to mark DDR regions as memory, based on the DDR size in hdf
</pre> @note None. Include Files /

FILES:
lib/bsp/standalone/src/arm/cortexr5/platform/versal/mpu.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xparameters_ps.h @addtogroup
r5_peripheral_definitions Cortex R5 peripheral definitions The xparameters_ps.h
file contains the canonical definitions and constant declarations for
peripherals within hardblock, attached to the ARM Cortex R5 core. These
definitions can be used by drivers or applications to access the peripherals. @{
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 7.00 mus
01/25/18 Initial version mn 03/26/18 Change Interrupt IDs for versal mn 03/26/18
Update SLCR base address </pre>

FILES:
lib/bsp/standalone/src/arm/cortexr5/platform/versal/xparameters_ps.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

print.c -- print a string on the output device. Copyright (c) 1995 Cygnus
Support The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided that
existing copyright notices are retained in all copies and that this notice is
included verbatim in any distributions. No written agreement, license, or
royalty fee is required for any of the authorized uses. Modifications to this
software may be copyrighted by their authors and need not follow the licensing
terms described here, provided that the new terms are clearly indicated on the
first page of each file where they apply. / print -- do a raw print of a string
/

FILES:
lib/bsp/standalone/src/common/print.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sleep.h This header file
contains ARM Cortex A53,A9,R5,Microblaze specific sleep related APIs. <pre>
MODIFICATION HISTORY : Ver Who Date Changes ----- ---- -------- 6.6 srm 11/02/17
Added processor specific sleep routines function prototypes. </pre>

FILES:
lib/bsp/standalone/src/common/sleep.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xbasic_types.h @note Dummy File
for backwards compatibility <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a adk 1/31/14 Added in bsp common folder for backward
compatibility 7.0 aru 01/21/19 Modified the typedef of u32,u16,u8 7.0 aru
02/06/19 Included stdint.h and stddef.h </pre>

FILES:
lib/bsp/standalone/src/common/xbasic_types.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenv.h Defines common services
that are typically found in a host operating. environment. This include file
simply includes an OS specific file based on the compile-time constant
BUILD_ENV_, where is the name of the target environment. All services are
defined as macros. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00b ch 10/24/02 Added XENV_LINUX 1.00a rmm 04/17/02 First release
</pre>

FILES:
lib/bsp/standalone/src/common/xenv.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xenv_standalone.h Defines
common services specified by xenv.h. @note This file is not intended to be
included directly by driver code. Instead, the generic xenv.h file is intended
to be included by driver code. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a wgr 02/28/07 Added cache handling macros. 1.00a wgr
02/27/07 Simplified code. Deprecated old-style macro names. 1.00a rmm 01/24/06
Implemented XENV_USLEEP. Assume implementation is being used under Xilinx
standalone BSP. 1.00a xd 11/03/04 Improved support for doxygen. 1.00a rmm
03/21/02 First release 1.00a wgr 03/22/07 Converted to new coding style. 1.00a
rpm 06/29/07 Added udelay macro for standalone 1.00a xd 07/19/07 Included
xparameters.h as XPAR_ constants are referred to in MICROBLAZE section 1.00a ecm
09/19/08 updated for v7.20 of Microblaze, new functionality </pre>

FILES:
lib/bsp/standalone/src/common/xenv_standalone.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_assert.c This file contains
basic assert related functions for Xilinx software IP. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a hbm 07/14/09 Initial
release 6.0 kvn 05/31/16 Make Xil_AsserWait a global variable </pre> Include
Files /

FILES:
lib/bsp/standalone/src/common/xil_assert.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_assert.h @addtogroup
common_assert_apis Assert APIs and Macros The xil_assert.h file contains assert
related functions and macros. Assert APIs/Macros specifies that a application
program satisfies certain conditions at particular points in its execution.
These function can be used by application programs to ensure that, application
code is satisfying certain conditions. @{ <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a hbm 07/14/09 First release 6.0 kvn
05/31/16 Make Xil_AsserWait a global variable </pre>

FILES:
lib/bsp/standalone/src/common/xil_assert.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache_vxworks.h Contains
the cache related functions for VxWorks that is wrapped by xil_cache. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a hbm
12/11/09 Initial release </pre> @note

FILES:
lib/bsp/standalone/src/common/xil_cache_vxworks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_hal.h Contains all the HAL
header files. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a hbm 07/28/09 Initial release </pre> @note

FILES:
lib/bsp/standalone/src/common/xil_hal.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_io.c Contains I/O functions
for memory-mapped or non-memory-mapped I/O architectures. @note This file
contains architecture-dependent code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- -------- -------- 5.00 pkp 05/29/14 First release </pre> Include
Files /

FILES:
lib/bsp/standalone/src/common/xil_io.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_io.h @addtogroup
common_io_interfacing_apis Register IO interfacing APIs The xil_io.h file
contains the interface for the general I/O component, which encapsulates the
Input/Output functions for the processors that do not require any special I/O
handling. @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --------
-------- 5.00 pkp 05/29/14 First release 6.00 mus 08/19/16 Remove checking of
__LITTLE_ENDIAN__ flag for ARM processors </pre>

FILES:
lib/bsp/standalone/src/common/xil_io.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_macroback.h This header
file is meant to bring back the removed _m macros. This header file must be
included last. The following macros are not defined here due to the driver
change: XGpio_mSetDataDirection XGpio_mGetDataReg XGpio_mSetDataReg XIIC_RESET
XIIC_CLEAR_STATS XSpi_mReset XSysAce_mSetCfgAddr XSysAce_mIsCfgDone
XTft_mSetPixel XTft_mGetPixel XWdtTb_mEnableWdt XWdtTb_mDisbleWdt
XWdtTb_mRestartWdt XWdtTb_mGetTimebaseReg XWdtTb_mHasReset Please refer the
corresponding driver document for replacement. /

FILES:
lib/bsp/standalone/src/common/xil_macroback.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mem.c This file contains
xil mem copy function to use in case of word aligned data copies. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- -------- -------- 6.1 nsk
11/07/16 First release. </pre> Include Files /

FILES:
lib/bsp/standalone/src/common/xil_mem.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_mem.h @addtogroup
common_mem_operation_api Customized APIs for Memory Operations The xil_mem.h
file contains prototype for functions related to memory operations. These APIs
are applicable for all processors supported by Xilinx. @{ <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- -------- -------- 6.1 nsk 11/07/16 First
release. 7.0 mus 01/07/19 Add cpp extern macro </pre>

FILES:
lib/bsp/standalone/src/common/xil_mem.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_sleepcommon.c This file
contains the sleep API's <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
-------- -------- 6.6 srm 11/02/17 First release </pre> Include Files /

FILES:
lib/bsp/standalone/src/common/xil_sleepcommon.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_testcache.c Contains
utility functions to test cache. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a hbm 07/28/09 Initial release 4.1 asa 05/09/14
Ensured that the address uses for cache test is aligned cache line. </pre> @note
This file contain functions that all operate on HAL.

FILES:
lib/bsp/standalone/src/common/xil_testcache.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_testcache.h @addtogroup
common_test_utils <h2>Cache test </h2> The xil_testcache.h file contains utility
functions to test cache. @{ <pre> Ver Who Date Changes ----- ---- -------- 1.00a
hbm 07/29/09 First release </pre>

FILES:
lib/bsp/standalone/src/common/xil_testcache.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_testio.c Contains the
memory test utility functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a hbm 08/25/09 First release </pre> Include Files /

FILES:
lib/bsp/standalone/src/common/xil_testio.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_testio.h @addtogroup
common_test_utils Test Utilities <h2>I/O test </h2> The xil_testio.h file
contains utility functions to test endian related memory IO functions. A subset
of the memory tests can be selected or all of the tests can be run in order. If
there is an error detected by a subtest, the test stops and the failure code is
returned. Further tests are not run even if all of the tests are selected. @{
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 hbm
08/05/09 First release </pre>

FILES:
lib/bsp/standalone/src/common/xil_testio.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_testmem.c Contains the
memory test utility functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a hbm 08/25/09 First release </pre> Include Files /

FILES:
lib/bsp/standalone/src/common/xil_testmem.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_testmem.h @addtogroup
common_test_utils <h2>Memory test</h2> The xil_testmem.h file contains utility
functions to test memory. A subset of the memory tests can be selected or all of
the tests can be run in order. If there is an error detected by a subtest, the
test stops and the failure code is returned. Further tests are not run even if
all of the tests are selected. Following list describes the supported memory
tests: - XIL_TESTMEM_ALLMEMTESTS: This test runs all of the subtests. -
XIL_TESTMEM_INCREMENT: This test starts at 'XIL_TESTMEM_INIT_VALUE' and uses the
incrementing value as the test value for memory. - XIL_TESTMEM_WALKONES: Also
known as the Walking ones test. This test uses a walking '1' as the test value
for memory. @code location 1 0x00000001 location 2 0x00000002 ... @endcode -
XIL_TESTMEM_WALKZEROS: Also known as the Walking zero's test. This test uses the
inverse value of the walking ones test as the test value for memory. @code
location 1 0xFFFFFFFE location 2 0xFFFFFFFD ... @endcode -
XIL_TESTMEM_INVERSEADDR: Also known as the inverse address test. This test uses
the inverse of the address of the location under test as the test value for
memory. - XIL_TESTMEM_FIXEDPATTERN: Also known as the fixed pattern test. This
test uses the provided patters as the test value for memory. If zero is provided
as the pattern the test uses '0xDEADBEEF". @warning The tests are
<b>DESTRUCTIVE</b>. Run before any initialized memory spaces have been set up.
The address provided to the memory tests is not checked for validity except for
the NULL case. It is possible to provide a code-space pointer for this test to
start with and ultimately destroy executable code causing random failures. @note
Used for spaces where the address range of the region is smaller than the data
width. If the memory range is greater than 2 width, the patterns used in
XIL_TESTMEM_WALKONES and XIL_TESTMEM_WALKZEROS will repeat on a boundary of a
power of two making it more difficult to detect addressing errors. The
XIL_TESTMEM_INCREMENT and XIL_TESTMEM_INVERSEADDR tests suffer the same problem.
Ideally, if large blocks of memory are to be tested, break them up into smaller
regions of memory to allow the test patterns used not to repeat over the region
tested. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a hbm 08/25/09 First release </pre>

FILES:
lib/bsp/standalone/src/common/xil_testmem.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_types.h @addtogroup
common_types Basic Data types for Xilinx&reg; Software IP The xil_types.h file
contains basic types for Xilinx software IP. These data types are applicable for
all processors supported by Xilinx. @{ <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a hbm 07/14/09 First release 3.03a sdm 05/30/11
Added Xuint64 typedef and XUINT64_MSW/XUINT64_LSW macros 5.00 pkp 05/29/14 Made
changes for 64 bit architecture srt 07/14/14 Use standard definitions from
stdint.h and stddef.h Define LONG and ULONG datatypes and mask values 7.00 mus
01/07/19 Add cpp extern macro </pre>

FILES:
lib/bsp/standalone/src/common/xil_types.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_util.c This file contains
xil utility functions <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
-------- -------- 6.4 mmd 04/21/19 First release. </pre> Include Files /

FILES:
lib/bsp/standalone/src/common/xil_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_util.h This file contains
xil utility functions declaration <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- -------- -------- 6.4 mmd 04/21/19 First release. </pre>

FILES:
lib/bsp/standalone/src/common/xil_util.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplatform_info.c This file
contains information about hardware for which the code is built <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.00 pkp 12/15/14
Initial release 5.04 pkp 01/12/16 Added platform information support for
Cortex-A53 32bit mode 6.00 mus 17/08/16 Removed unused variable from
XGetPlatform_Info 6.4 ms 05/23/17 Added PSU_PMU macro to support
XGetPSVersion_Info function for PMUFW. ms 06/13/17 Added PSU_PMU macro to
provide support of XGetPlatform_Info function for PMUFW. mus 08/17/17 Add EL1 NS
mode support for XGet_Zynq_UltraMp_Platform_info and XGetPSVersion_Info APIs.
7.0 aru 03/15/19 Check for versal before aarch64 and armr5 in
XGetPlatform_Info() </pre> Include Files /

FILES:
lib/bsp/standalone/src/common/xplatform_info.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplatform_info.h @addtogroup
common_platform_info APIs to Get Platform Information The xplatform_info.h file
contains definitions for various available Xilinx&reg; platforms. Also, it
contains prototype of APIs, which can be used to get the platform information.
@{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------- 6.4 ms
05/23/17 Added PSU_PMU macro to support XGetPSVersion_Info function for PMUFW.
</pre>

FILES:
lib/bsp/standalone/src/common/xplatform_info.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xstatus.h @addtogroup
common_status_codes Xilinx&reg; software status codes The xstatus.h file
contains the Xilinx&reg; software status codes.These codes are used throughout
the Xilinx device drivers. @{

FILES:
lib/bsp/standalone/src/common/xstatus.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. The following are defined in
config.make LIBSOURCES - Based on if MicroBlaze support Exceptions LIBS - Do
Build Profile Libraries

FILES:
lib/bsp/standalone/src/microblaze/Makefile
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mb_interface.h @addtogroup
microblaze_pseudo_asm_macro Microblaze Pseudo-asm Macros and Interrupt Handling
APIs Microblaze BSP includes macros to provide convenient access to various
registers in the MicroBlaze processor. Some of these macros are very useful
within exception handlers for retrieving information about the exception.Also,
the interrupt handling functions help manage interrupt handling on MicroBlaze
processor devices.To use these functions, include the header file mb_interface.h
in your source code @{

FILES:
lib/bsp/standalone/src/microblaze/mb_interface.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_exception_handler.c
This file contains exception handler registration routines for the MicroBlaze
processor. <pre> MODIFICATION HISTORY: Ver Date Changes ----- -------- 1.00b
06/24/04 First release </pre> Include Files /

FILES:
lib/bsp/standalone/src/microblaze/microblaze_exception_handler.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_exceptions_g.h This
file contains the exception handling information for the MicroBlaze processor.
This file is usually generated by LibGen. <pre> MODIFICATION HISTORY: Ver Date
Changes ----- -------- 1.00a 06/24/04 First release </pre>

FILES:
lib/bsp/standalone/src/microblaze/microblaze_exceptions_g.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_exceptions_i.h This
header file contains defines for structures used by the microblaze hardware
exception handler. <pre> MODIFICATION HISTORY: Ver Date Changes ----- --------
1.00a 06/24/04 First release </pre>

FILES:
lib/bsp/standalone/src/microblaze/microblaze_exceptions_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_instructions.h It
provides wrapper macros to call 32/64 bit variant of specific arithmetic/logical
instructions, based on the processor in execution. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- -------- -------- 6.8 mus 10/09/18 First release
</pre>

FILES:
lib/bsp/standalone/src/microblaze/microblaze_instructions.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_interrupt_handler.c
This file contains the standard interrupt handler for the MicroBlaze processor.
<pre> MODIFICATION HISTORY: Ver Date Changes ----- -------- 1.00b 10/03/03 First
release </pre> Include Files /

FILES:
lib/bsp/standalone/src/microblaze/microblaze_interrupt_handler.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_interrupts_g.c This
file contains the interrupt handler table for the MicroBlaze processor. This
file is usually generated by LibGen. <pre> MODIFICATION HISTORY: Ver Date
Changes ----- -------- 1.00b 10/03/03 First release </pre>

FILES:
lib/bsp/standalone/src/microblaze/microblaze_interrupts_g.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_interrupts_i.h This
header file contains identifiers and low-level driver functions (or macros) that
can be used to access the device. The user should refer to the hardware device
specification for more details of the device operation. High-level driver
functions are defined in xintc.h. <pre> MODIFICATION HISTORY: Ver Date Changes
----- -------- 1.00b 10/03/03 First release </pre>

FILES:
lib/bsp/standalone/src/microblaze/microblaze_interrupts_i.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_sleep.c Contains
implementation of microblaze sleep function. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 4.1 hk 04/18/14 Add sleep function. 6.0 asa
08/15/16 Updated the sleep/usleep signature. Fix for CR956899. 6.6 srm 10/18/17
Updated sleep routines to support user configurable implementation. Now sleep
routines will use Axi Timer or machine cycles as specified by the user. 6.8 mus
10/04/18 FreeRTOS BSP always use default method for sleep implementation, It
does not have user configurable sleep implementation support, that is why
FreeRTOS tcl does not export XSLEEP_TIMER_IS_DEFAULT_TIMER macro to
xparameters.h. Modified code to always use default timer path for FreeRTOS BSP,
based on the "FREERTOS_BSP" macro. It fixes CR1012363. </pre> @note This file
may contain architecture-dependent code. Include Files /

FILES:
lib/bsp/standalone/src/microblaze/microblaze_sleep.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file microblaze_sleep.h @addtogroup
microblaze_sleep_routines Sleep Routines for Microblaze The microblaze_sleep.h
file contains microblaze sleep APIs. These APIs provides delay for requested
duration. @{ <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 4.1 asa 04/18/14 Add sleep function - first release. 6.6 srm 10/18/17
Added the Register offset definitions and Control/Status Register bit masks of
the Axi timer. </pre> @note The microblaze_sleep.h file may contain
architecture-dependent items.

FILES:
lib/bsp/standalone/src/microblaze/microblaze_sleep.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pvr.c This header file contains
defines for structures used by the microblaze PVR routines

FILES:
lib/bsp/standalone/src/microblaze/pvr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pvr.h @addtogroup
microblaze_pvr_macros Microblaze PVR access routines and macros MicroBlaze
processor v5.00.a and later versions have configurable Processor Version
Registers (PVRs). The contents of the PVR are captured using the pvr_t data
structure, which is defined as an array of 32-bit words, with each word
corresponding to a PVR register on hardware. The number of PVR words is
determined by the number of PVRs configured in the hardware. You should not
attempt to access PVR registers that are not present in hardware, as the pvr_t
data structure is resized to hold only as many PVRs as are present in hardware.
To access information in the PVR: 1. Use the microblaze_get_pvr() function to
populate the PVR data into a pvr_t data structure. 2. In subsequent steps, you
can use any one of the PVR access macros list to get individual data stored in
the PVR. 3. pvr.h header file must be included to source to use PVR macros. @{

FILES:
lib/bsp/standalone/src/microblaze/pvr.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.c This contains
implementation of cache related driver functions. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 hbm 07/28/09 Initial release 3.10
asa 05/04/13 This version of MicroBlaze BSP adds support for system cache/L2
cache. Existing APIs in this file are modified to add support for L2 cache.
These changes are done for implementing PR 697214. </pre> @note None.

FILES:
lib/bsp/standalone/src/microblaze/xil_cache.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_cache.h The xil_cache.h
file contains cache related driver functions (or macros) that can be used to
access the device. The user should refer to the hardware device specification
for more details of the device operation. The functions in this header file can
be used across all Xilinx supported processors. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 hbm 07/28/09 Initial release 3.02a sdm
10/24/11 Updated the file to include xparameters.h so that the correct cache
flush routines are used based on whether the write-back or write-through caches
are used (cr 630532). 3.10a asa 05/04/13 This version of MicroBlaze BSP adds
support for system cache/L2 cache. The existing/old APIs/macros in this file are
renamed to imply that they deal with L1 cache. New macros/APIs are added to
address similar features for L2 cache. Users can include this file in their
application to use the various cache related APIs. These changes are done for
implementing PR 697214. </pre> @note

FILES:
lib/bsp/standalone/src/microblaze/xil_cache.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_exception.c This file
contains implementation of exception related driver functions. @addtogroup
microblaze_exception_apis Microblaze exception APIs @{ <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 hbm 07/28/09 Initial
release 6.2 ms 02/20/17 Fixed compilation warning. This is a fix for CR-969126.
</pre> @note None.

FILES:
lib/bsp/standalone/src/microblaze/xil_exception.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_exception.h @addtogroup
microblaze_exception_apis Microblaze Exception APIs The xil_exception.h file
contains Microblaze specific exception related APIs and macros. Application
programs can use these APIs/Macros for various exception related operations
(i.e. enable exception, disable exception, register exception handler etc.) @{
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 hbm
07/28/09 Initial release </pre> @note To use exception related functions, the
xil_exception.h file must be added in source code

FILES:
lib/bsp/standalone/src/microblaze/xil_exception.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xil_misc_reset.c This file
contains the implementation of the reset sequence for various zynq ps devices
like DDR,OCM,Slcr,Ethernet,Usb.. controllers. The reset sequence provided to the
interfaces is based on the provision in slcr reset functional block. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00b kpc
03/07/13 First release 5.4 pkp 16/11/15 Change the description for XOcm_Remap
function </pre> Include Files /

FILES:
lib/bsp/standalone/src/microblaze/xil_misc_psreset_api.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Makefile for profiler
PROFILE_ARCH_OBJS - Processor Architecture Dependent files defined here

FILES:
lib/bsp/standalone/src/profile/Makefile
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. _program_init.c: Initialize the
Profiling Structures.

FILES:
lib/bsp/standalone/src/profile/_profile_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. _program_timer_hw.c: Timer related
functions

FILES:
lib/bsp/standalone/src/profile/_profile_timer_hw.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. _program_timer_hw.h: Timer related
functions

FILES:
lib/bsp/standalone/src/profile/_profile_timer_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Zynq DDR Self-refresh This DDR self
refresh application provides a simple demonstration of how to enter to/exit from
DDR self refresh mode. This application runs on R5 out of TCM. /

FILES:
lib/sw_apps/ddr_self_refresh/src/main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. All
Rights Reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. If you wish to use our Amazon
FreeRTOS name, please do so in a fair use way that does not cause confusion. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
http://www.FreeRTOS.org http://aws.amazon.com/freertos 1 tab 4 spaces! FreeRTOS
includes. /

FILES:
lib/sw_apps/freertos_hello_world/src/freertos_hello_world.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / Connection handle for a TCP Client
session /

FILES:
lib/sw_apps/freertos_lwip_tcp_perf_client/src/freertos_tcp_perf_client.c
lib/sw_apps/lwip_tcp_perf_client/src/tcp_perf_client.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / Connection handle for a UDP Client
session /

FILES:
lib/sw_apps/freertos_lwip_udp_perf_client/src/udp_perf_client.c
lib/sw_apps/lwip_udp_perf_client/src/udp_perf_client.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / Connection handle for a UDP Server
session /

FILES:
lib/sw_apps/freertos_lwip_udp_perf_server/src/udp_perf_server.c
lib/sw_apps/lwip_udp_perf_server/src/udp_perf_server.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Xilinx nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / ipi_latency_demod.c This is the
remote side of the IPI latency measurement demo. This demo does the following
steps: 1. Open the shared memory device. 1. Open the TTC timer device. 2. Open
the IPI device. 3. Register IPI interrupt handler. 6. When it receives IPI
interrupt, the IPI interrupt handler to stop the RPU to APU TTC counter. 7.
Check the shared memory to see if demo is on. If the demo is on, reest the RPU
to APU TTC counter and kick IPI to notify the remote. 8. If the shared memory
indicates the demo is off, cleanup resource: disable IPI interrupt and
deregister the IPI interrupt handler. /

FILES:
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/ipi_latency_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/ipi_latency_demod.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Xilinx nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / ipi_shmem_demo.c - shared memory
with IPI demo This demo will: 1. Get the shared memory device I/O region. 2. Get
the IPI device I/O region. 3. Register IPI interrupt handler. 4. Wait for remote
IPI notification to receive message. 5. When message is received, check if it is
shutdown message. 6. If it is shutdown message, do cleanup, otherwise, echo it
back to the shared buffer. 7. Kick IPI to notify there is a message written to
the shared memory if it echos back the message. 8. Repeat 4. 9. Clean up:
disable IPI interrupt, deregister the IPI interrupt handler. Here is the Shared
memory structure of this demo: |0x0 - 0x03 | number of APU to RPU buffers
available to RPU | |0x04 - 0x07 | number of APU to RPU buffers consumed by RPU |
|0x08 - 0x1FFC | address array for shared buffers from APU to RPU | |0x2000 -
0x2003 | number of RPU to APU buffers available to APU | |0x2004 - 0x2007 |
number of RPU to APU buffers consumed by APU | |0x2008 - 0x3FFC | address array
for shared buffers from RPU to APU | |0x04000 - 0x103FFC | APU to RPU buffers |
|0x104000 - 0x203FFC | RPU to APU buffers | /

FILES:
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/ipi_shmem_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/ipi_shmem_demod.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Xilinx nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / shmem_latency_demod.c This is the
remote side of the IPI latency measurement demo. This demo does the following
steps: 1. Get the shared memory device libmetal I/O region. 1. Get the TTC timer
device libemtal I/O region. 2. Get IPI device libmetal I/O region and the IPI
interrupt vector. 3. Register IPI interrupt handler. 6. When it receives IPI
interrupt, the IPI interrupt handler marked the remote has kicked. 7. Check the
shared memory to see if demo is on. If the demo is on, copy data from the shared
memory to local memory, stop the APU to RPU timer. Reset the RPU to APU TTC
counter, copy data from local memory to shared memory, kick IPI to notify the
remote. 8. If the shared memory indicates the demo is off, cleanup resource:
disable IPI interrupt and deregister the IPI interrupt handler. /

FILES:
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/shmem_latency_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/shmem_latency_demod.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. Neither the name of Xilinx nor the names of
its contributors may be used to endorse or promote products derived from this
software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY
THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / shmem_throughput_demo_task.c This
is the remote side of the shared memory throughput demo. This demo does the
following steps: 1. Get the shared memory device libmetal I/O region. 1. Get the
TTC timer device libemtal I/O region. 2. Get IPI device libmetal I/O region and
the IPI interrupt vector. 3. Register IPI interrupt handler. 6. Download
throughput measurement: Start TTC RPU counter, wait for IPI kick, check if data
is available, if yes, read as much data as possible from shared memory. It will
iterates until 1000 packages have been received, stop TTC RPU counter and kick
IPI to notify the remote. Repeat for different package size. 7. Upload
throughput measurement: Start TTC RPU counter, write data to shared memory and
kick IPI to notify remote. It will iterate for 1000 times, stop TTC RPU counter.
wait for APU IPI kick to know APU has finished receiving packages. Kick IPI to
notify it TTC RPU conter value is ready to read. Repeat for different package
size. 8. Cleanup resource: disable IPI interrupt and deregister the IPI
interrupt handler. Here is the Shared memory structure of this demo: |0x0 - 0x03
| number of APU to RPU buffers available to RPU | |0x04 - 0x1FFFFF | address
array for shared buffers from APU to RPU | |0x200000 - 0x200004 | number of RPU
to APU buffers available to APU | |0x200004 - 0x3FFFFF | address array for
shared buffers from RPU to APU | |0x400000 - 0x7FFFFF | APU to RPU buffers |
|0x800000 - 0xAFFFFF | RPU to APU buffers | /

FILES:
lib/sw_apps/libmetal_echo_demo/src/system/freertos/zynqmp_r5/zynqmp_amp_demo/shmem_throughput_demod.c
lib/sw_apps/libmetal_echo_demo/src/system/generic/zynqmp_r5/zynqmp_amp_demo/shmem_throughput_demod.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / platform_ppc.c PPC specific
functions to setup timer /

FILES:
lib/sw_apps/lwip_echo_server/src/platform_ppc.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2] [Google]

COPYRIGHT TEXT:
---------------

All rights reserved. Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following conditions are
met: 1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. 2. Redistributions in
binary form must reproduce the above copyright notice, this list of conditions
and the following disclaimer in the documentation and/or other materials
provided with the distribution. 3. The name of the author may not be used to
endorse or promote products derived from this software without specific prior
written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. / Connection handle for a TCP Server
session /

FILES:
lib/sw_apps/lwip_tcp_perf_server/src/tcp_perf_server.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fs-boot.c DESCRIPTION: This is
the main program for the first-stage bootloader FS-BOOT for the PetaLinux
distribution. This bootloader is targeted for reconfigurable platform and is
designed to be run from BRAM. Hence, elf size must remain below 8K bytes. It
supports the booting of any second-stage bootloader from FLASH or RAM memory.
Note: This program requires the following hardware support: - XuartLite or
uart16550 - BRAM > 8Kb

FILES:
lib/sw_apps/mba_fs_boot/src/fs-boot.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fs-boot.h DESCRIPTION: Header
file for the Xilinx Inc. first-stage bootloader FS-BOOT.

FILES:
lib/sw_apps/mba_fs_boot/src/fs-boot.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xspi.h /

FILES:
lib/sw_apps/mba_fs_boot/src/fs-xspi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file spi-flash.h /

FILES:
lib/sw_apps/mba_fs_boot/src/spi-flash.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation. All rights reserved. All rights
reserved. SPDX-License-Identifier: BSD-3-Clause / FILE NAME platform_info.c
DESCRIPTION This file define platform specific data and implements APIs to set
platform specific information for OpenAMP. /

FILES:
lib/sw_apps/openamp_echo_test/src/machine/zynq7/platform_info.c
lib/sw_apps/openamp_matrix_multiply/src/machine/zynq7/platform_info.c
lib/sw_apps/openamp_rpc_demo/src/machine/zynq7/platform_info.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. All rights
reserved. SPDX-License-Identifier: BSD-3-Clause / This file populates resource
table for BM remote for use by the Linux Master /

FILES:
lib/sw_apps/openamp_echo_test/src/machine/zynq7/rsc_table.c
lib/sw_apps/openamp_echo_test/src/machine/zynq7/rsc_table.h
lib/sw_apps/openamp_echo_test/src/machine/zynqmp_r5/rsc_table.c
lib/sw_apps/openamp_echo_test/src/machine/zynqmp_r5/rsc_table.h
lib/sw_apps/openamp_matrix_multiply/src/machine/zynq7/rsc_table.c
lib/sw_apps/openamp_matrix_multiply/src/machine/zynq7/rsc_table.h
lib/sw_apps/openamp_matrix_multiply/src/machine/zynqmp_r5/rsc_table.c
lib/sw_apps/openamp_matrix_multiply/src/machine/zynqmp_r5/rsc_table.h
lib/sw_apps/openamp_rpc_demo/src/machine/zynq7/rsc_table.c
lib/sw_apps/openamp_rpc_demo/src/machine/zynq7/rsc_table.h
lib/sw_apps/openamp_rpc_demo/src/machine/zynqmp_r5/rsc_table.c
lib/sw_apps/openamp_rpc_demo/src/machine/zynqmp_r5/rsc_table.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / FILE NAME platform_info.c DESCRIPTION This
file define platform specific data and implements APIs to set platform specific
information for OpenAMP. /

FILES:
lib/sw_apps/openamp_echo_test/src/machine/zynqmp_r5/platform_info.c
lib/sw_apps/openamp_matrix_multiply/src/machine/zynqmp_r5/platform_info.c
lib/sw_apps/openamp_rpc_demo/src/machine/zynqmp_r5/platform_info.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Copyright (c) 2014, Mentor Graphics Corporation All rights reserved. SPDX-
License-Identifier: BSD-3-Clause / FILE NAME zynqmp_r5_a53_rproc.c DESCRIPTION
This file define Xilinx ZynqMP R5 to A53 platform specific remoteproc
implementation. /

FILES:
lib/sw_apps/openamp_echo_test/src/machine/zynqmp_r5/zynqmp_r5_a53_rproc.c
lib/sw_apps/openamp_matrix_multiply/src/machine/zynqmp_r5/zynqmp_r5_a53_rproc.c
lib/sw_apps/openamp_rpc_demo/src/machine/zynqmp_r5/zynqmp_r5_a53_rproc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rsa_auth_app.c This file
contains the implementation of the SW app used to validate any user application.
It makes use of librsa to do the same. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- --- -------- 1.0 hk 27/01/14 First release </pre>
Include Files /

FILES:
lib/sw_apps/rsa_auth_app/src/rsa_auth_app.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rsa_auth_app.h This file is the
header to the SW app used to authenticate a user application and contains the
necessary definitions and prototypes. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- --- -------- 1.0 hk 27/01/14 First release </pre>

FILES:
lib/sw_apps/rsa_auth_app/src/rsa_auth_app.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_default.h This is the
default header file which contains definitions for the PLM. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 07/12/2018 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_plm/src/xplm_default.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_hooks.c This file contains
the hook functions for the user <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 03/08/2019 Initial release </pre> @note Include
Files /

FILES:
lib/sw_apps/versal_plm/src/xplm_hooks.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_hooks.h This file contains
the declarations for the hooks provided in PLM <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 03/08/2019 Initial release </pre>
@note

FILES:
lib/sw_apps/versal_plm/src/xplm_hooks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_loader.c This file
contains the wrapper functions for platform loader <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 08/20/2018 Initial release
</pre> @note Include Files /

FILES:
lib/sw_apps/versal_plm/src/xplm_loader.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_loader.h This file
contains the declarations of platform loader wrapper functions <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc
07/20/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_plm/src/xplm_loader.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_main.c This is the main
file which contains code for the PLM. <pre> MODIFICATION HISTORY: Ver Who Date
Changes 1.00 kc 07/12/2018 Initial release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_plm/src/xplm_main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_main.h This is the main
header file which contains definitions for the PLM. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 07/12/2018 Initial release
</pre> @note

FILES:
lib/sw_apps/versal_plm/src/xplm_main.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_module.c This file
contains the module initialization code for PLM. <pre> MODIFICATION HISTORY: Ver
Who Date Changes 1.00 kc 08/28/2018 Initial release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_plm/src/xplm_module.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_module.h This file
contains the headers for startup code of PLM. <pre> MODIFICATION HISTORY: Ver
Who Date Changes 1.00 kc 08/28/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_plm/src/xplm_module.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_pm.c This file contains
the wrapper code xilpm <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 kc 07/20/2018 Initial release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_plm/src/xplm_pm.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_pm.n This file contains
the header functions of wrapper xilpm <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 07/20/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_plm/src/xplm_pm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_proc.c This file contains
the processor related code. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 03/27/2018 Initial release </pre> @note Include
Files /

FILES:
lib/sw_apps/versal_plm/src/xplm_proc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_proc.h This file contains
declarations for PROC C file in PLM. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 07/24/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_plm/src/xplm_proc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_startup.c This file
contains the startup tasks related code for PLM. <pre> MODIFICATION HISTORY: Ver
Who Date Changes 1.00 kc 08/28/2018 Initial release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_plm/src/xplm_startup.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_startup.h This file
contains the headers for startup code of PLM. <pre> MODIFICATION HISTORY: Ver
Who Date Changes 1.00 kc 08/28/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_plm/src/xplm_startup.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilcdo.c This is the file
which contains psu3 functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 03/20/2017 Initial release </pre> @note / Include
Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xilcdo.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_cdo.h This is the file
which contains psu3 functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 03/16/2017 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xilcdo.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilcdo_npi.c This is the file
which contains CDO NPI functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 03/20/2017 Initial release </pre> @note /
Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xilcdo_npi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilcdo_npi.h This is the file
which contains CDO NPI functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 bsv 01/05/18 Initial release </pre> @note /

FILES:
lib/sw_apps/versal_pmcfw/src/xilcdo_npi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_board.c This file
contains board/platform specific code of PMCFW. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_board.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_config.h This is the
header file which contains PMCFW configuration for users. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_crx.c This file which
contains the code related to clock and resets. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_crx.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMDDRIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF DDRRCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE
AND NONINFRINGEDDRNT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_crx.h This
is the file which contains code for clock and reset functionality <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc
02/21/2017 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_crx.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_debug.h This file
contains the debug verbose information for PMCFW print functionality <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a kc
02/23/2017 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_default.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_dma.c This is the file
which contains PMC DMA interface code for the PMCFW. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 12/21/2017 Initial release
</pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_dma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_dma.h This is the file
which contains common code for the PMCFW. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_dma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_error.h This is the
header file which contains error codes for the PMCFW. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_err.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF PLRCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEPLNT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_fabric.c This file which
contains the code related to PL. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre> @note
Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_fabric.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF PLRCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEPLNT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_fabric.h This is the
file which contains code related to Fabric. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_fabric.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_handoff.c This is the
main file which contains handoff code for the PMCFW. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release
</pre> @note / Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_handoff.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_hooks.c This is the file
which contains PMCFW hook functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 04/21/2017 Initial release </pre> @note
Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_hooks.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_hooks.h This is the
header file which contains definitions for the PMCFW hooks <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_hooks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_hw.h This is the header
file which contains definitions for the hardware registers. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xpmcfw_initilization.c This
is the file which contains initialization code for the PMCFW. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xpmcfw_iomodule.c This is the
file which contains iomodule interface functions. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 03/27/2018 Initial release
</pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_iomodule.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_iomodule.h This is the
file which contains common code for the PMCFW. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 03/27/2018 Initial release </pre>
@note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_iomodule.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_main.c This is the main
file which contains code for the PMCFW. <pre> MODIFICATION HISTORY: Ver Who Date
Changes - 1.00 kc 2/21/2017 Initial release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_main.h This is the main
header file which contains definitions for the PMCFW. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_main.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_misc.c This is the file
which contains common utilities code for the PMCFW. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release
</pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_misc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_misc.h This is the file
which contains common code for the PMCFW. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_misc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_npi.c This file contains
the static NPI configurations taken from verif team <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release
</pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_npi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_ospi.c This is the file
which contains ospi related code for the PMCFW. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 bsv 08/23/2018 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_ospi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_ospi.h This is the
header file which contains ospi declarations for the PMCFW. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_ospi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_pdi.c This is the image
header C file which does validation for the image header. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_pdi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_prtn_load.c This is the
file which contains partition load code for the PMCFW. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_prtn_load.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_qspi.c This is the file
which contains qspi related code for the PMCFW. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 02/21/2018 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_qspi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_qspi.h This is the
header file which contains qspi declarations for the PMCFW. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_qspi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_sbi.c This is the file
which contains SBI related code for the PMC FW. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 09/21/2017 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_sbi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_sd.c This is the file
which contains sd related code for the PMC FW. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 09/21/2017 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_sd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_uart.c This is the file
which contains uart initialization code for the PMCFW. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 05/04/2018 Initial
release </pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_uart.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_util.c This file which
contains the code which interfaces with the CRP <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpmcfw_util.h This is the
header file PMC FW utilities code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xpmcfw_util.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure.c This file contains
the implementation of the interface functions for secure library. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.0 DP 02/15/17
Initial release 2.2 vns 09/18/17 Added APIs to support generic functionality for
SHA3 and RSA hardware at linux level. Removed RSA-SHA2 authentication support
for loading linux image and dtb from u-boot, as here it is using SHA2 hash and
single RSA key pair authentication 3.0 vns 02/21/18 Added support for single
partition image authentication and/or decryption. 3.1 vns 04/13/18 Added device
key support even if authentication is not been enabled for single partition
image, when PMUFW is compiled by enabling secure environment variable in bsp
settings. ka 04/10/18 Added support for user-efuse revocation ka 04/18/18 Added
support for Zeroization of the memory in case of Gcm-Tag mismatch 3.2 ka
04/04/18 Added support for Sha3_Update, if the payload is not 4 bytes aligned.
vnc 08/21/18 Added support for PMCFW </pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure.h This is the header
file which contains secure library interface function prototype for
authentication and decryption of images. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 dp 02/15/17 Initial release 2.2 vns
09/18/17 Added APIs to support generic functionality for SHA3 and RSA hardware
at linux level. 3.0 vns 02/19/18 Added error codes and macros for secure image.
3.1 ka 04/10/18 Added support for user-efuse revocation ka 04/18/18 Added
support for Zeroization of the memory in case of Gcm-Tag mismatch vnc 08/21/18
Added support for PMC FW </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_aes.c This file
contains the implementation of the interface functions for AES driver. Refer to
the header file xsecure_aes.h for more detailed information. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.00 ba 09/10/14 Initial
release 1.1 ba 11/10/15 Modified Key loading logic in AES encryption 1.1 ba
12/22/15 Added Chunking support in decryption 2.0 vns 01/28/17 Added APIs for
decryption which can be used for generic decryption. vns 02/03/17 Added APIs for
encryption in generic way. Removed existing XSecure_AesEncrypt API Modified
encryption and decryption APIs such that all inputs will be accepted in little
endian format(KEY, IV and Data). 2.2 vns 07/06/16 Added doxygen tags </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure_aes.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xsecure_aes.h This file contains hardware interface related
information for CSU AES device This driver supports the following features: -
AES decryption with/without keyrolling - Authentication using GCM tag
<b>Initialization & Configuration</b> The Aes driver instance can be initialized
in the following way: - XSecure_AesInitialize(XSecure_Aes InstancePtr, XCsuDma
CsuDmaPtr, u32 KeySel, u32 Iv, u32 Key) The key for decryption can be the device
key or user provided key. KeySel variable denotes the key to be used. In case
the key is user provided, key has to be provided in Key variable. If it is
device key, the key variable will be ignored and device key will be used The
initial Initialization vector will be used for decrypting secure header and
block 0 of given encrypted data. @note -The format of encrypted data(boot image)
has to be exactly as specified by the bootgen. Any encrypted data has to start
with a secure header first and then the data blocks. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 ba 10/10/14 Initial release 1.1 ba
11/10/15 Modified Key loading logic in AES encryption </pre>

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure_aes.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_hw.h This is the header
file which contains definitions for the hardware interface of secure hardware
devices. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00 ba 09/25/14 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure_hw.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xsecure_rsa.h This file contains hardware interface related
information for RSA device This driver supports the following features: - RSA
4096 based decryption - verification/authentication of decrypted data
<b>Initialization & Configuration</b> The Rsa driver instance can be initialized
in the following way: - XSecure_RsaInitialize(XSecure_Rsa InstancePtr, u8
EncText, u8 Mod, u8 ModExt, u8 ModExpo) The method used for RSA decryption needs
precalculated value off R^2 mod N which is generated by bootgen and is present
in the signature along with modulus and exponent. @note -The format of the
public key( modulus, exponent and precalculated R^2 mod N should be same as
specified by the bootgen -For matching, PKCS paddding scheme has to be applied
in the manner specified by the bootgen. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 ba 10/10/14 Initial release </pre>

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure_rsa.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xsecure_sha.c This file contains the implementation of the
interface functions for SHA driver. Refer to the header file xsecure_sha.h for
more detailed information. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 ba 08/10/14 Initial release </pre> @note Include Files
/

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure_sha.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

All rights reserved. This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail-safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. @file xsecure_sha.h This file Contains the function prototypes,
defines and macros for the SHA-384 hardware module. This driver supports the
following features: - SHA-3 hash calculation <b>Initialization &
Configuration</b> The SHA-3 driver instance can be initialized in the following
way: - XSecure_Sha3Initialize(XSecure_Sha3 InstancePtr, XCsuDma CsuDmaPtr) A
pointer to CsuDma instance has to be passed in initialization as CSU DMA will be
used for data transfers to SHA module. @note <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 ba 11/05/14 Initial release </pre> @note

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure_sha.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa.c This file
contains the implementation of the interface functions for RSA driver. Refer to
the header file xsecure_sha.h for more detailed information. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 ba 10/13/14 Initial
release 1.1 ba 12/11/15 Added support for NIST approved SHA-3 in 2.0 silicon 2.0
vns 03/15/17 Fixed compilation warning, and corrected SHA2 padding verification
for silicon version other than 1.0 </pre> @note Include Files /

FILES:
lib/sw_apps/versal_pmcfw/src/xsecure_rsa.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
cframe0_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/cframe0_reg.h
lib/sw_apps/versal_pmcfw/src/hw90/cframe0_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
cframe_bcast_reg.h This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/cframe_bcast_reg.h
lib/sw_apps/versal_pmcfw/src/hw90/cframe_bcast_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
cfu_apb.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/cfu_apb.h
lib/sw_apps/versal_pmcfw/src/hw90/cfu_apb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
cpm_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/cpm_slcr.h
lib/sw_apps/versal_pmcfw/src/hw90/cpm_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
crf.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/crf.h
lib/sw_apps/versal_pmcfw/src/hw90/crf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
crl.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/crl.h
lib/sw_apps/versal_pmcfw/src/hw90/crl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
crp.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/crp.h
lib/sw_apps/versal_pmcfw/src/hw90/crp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
efuse_cache.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/efuse_cache.h
lib/sw_apps/versal_pmcfw/src/hw90/efuse_cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
fpd_apu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/fpd_apu.h
lib/sw_apps/versal_pmcfw/src/hw90/fpd_apu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
lpd_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/lpd_iou_slcr.h
lib/sw_apps/versal_pmcfw/src/hw90/lpd_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
pmc_analog.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/pmc_analog.h
lib/sw_apps/versal_pmcfw/src/hw90/pmc_analog.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
pmc_dma0.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/pmc_dma0.h
lib/sw_apps/versal_pmcfw/src/hw90/pmc_dma0.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
pmc_dma1.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/pmc_dma1.h
lib/sw_apps/versal_pmcfw/src/hw90/pmc_dma1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
pmc_global.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/pmc_global.h
lib/sw_apps/versal_pmcfw/src/hw90/pmc_global.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
pmc_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/pmc_iou_slcr.h
lib/sw_apps/versal_pmcfw/src/hw90/pmc_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
pmc_tap.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/pmc_tap.h
lib/sw_apps/versal_pmcfw/src/hw90/pmc_tap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
psm_global_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/psm_global_reg.h
lib/sw_apps/versal_pmcfw/src/hw90/psm_global_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
rpu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/rpu.h
lib/sw_apps/versal_pmcfw/src/hw90/rpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-11-11 @file:
slave_boot.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw100/slave_boot.h
lib/sw_apps/versal_pmcfw/src/hw90/slave_boot.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
cframe0_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/cframe0_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
cframe_bcast_reg.h This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/cframe_bcast_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
cfu_apb.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/cfu_apb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
cpm_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/cpm_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
crf.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/crf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
crl.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/crl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
crp.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/crp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
efuse_cache.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/efuse_cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
fpd_apu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/fpd_apu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
lpd_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/lpd_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
pmc_analog.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/pmc_analog.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
pmc_dma0.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/pmc_dma0.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
pmc_dma1.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/pmc_dma1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
pmc_global.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/pmc_global.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
pmc_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/pmc_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
pmc_tap.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/pmc_tap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
psm_global_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/psm_global_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
rpu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/rpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-12-08 @file:
slave_boot.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw110/slave_boot.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
cframe0_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/cframe0_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
cframe_bcast_reg.h This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/cframe_bcast_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
cfu_apb.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/cfu_apb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
crf.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/crf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
crl.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/crl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
crp.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/crp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
efuse_cache.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/efuse_cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
fpd_apu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/fpd_apu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
pmc_analog.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/pmc_analog.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
pmc_dma0.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/pmc_dma0.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
pmc_dma1.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/pmc_dma1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
pmc_global.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/pmc_global.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
pmc_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/pmc_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
pmc_tap.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/pmc_tap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
psm_global_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/psm_global_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
rpu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/rpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-05-06 @file:
slave_boot.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw50/slave_boot.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
cframe0_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/cframe0_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
cframe_bcast_reg.h This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/cframe_bcast_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
cfu_apb.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/cfu_apb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
cpm_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/cpm_slcr.h
lib/sw_apps/versal_pmcfw/src/hw70/cpm_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
crf.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/crf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
crl.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/crl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
crp.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/crp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
efuse_cache.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/efuse_cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
fpd_apu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/fpd_apu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
lpd_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/lpd_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
pmc_analog.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/pmc_analog.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
pmc_dma0.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/pmc_dma0.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
pmc_dma1.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/pmc_dma1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
pmc_global.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/pmc_global.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
pmc_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/pmc_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
pmc_tap.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/pmc_tap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
psm_global_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/psm_global_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
rpu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/rpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-06-19 @file:
slave_boot.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw60/slave_boot.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
cframe0_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/cframe0_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
cframe_bcast_reg.h This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/cframe_bcast_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
cfu_apb.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/cfu_apb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
crf.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/crf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
crl.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/crl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
crp.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/crp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
efuse_cache.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/efuse_cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
fpd_apu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/fpd_apu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
lpd_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/lpd_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
pmc_analog.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/pmc_analog.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
pmc_dma0.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/pmc_dma0.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
pmc_dma1.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/pmc_dma1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
pmc_global.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/pmc_global.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
pmc_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/pmc_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
pmc_tap.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/pmc_tap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
psm_global_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/psm_global_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
rpu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/rpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-08-14 @file:
slave_boot.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw70/slave_boot.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
cframe0_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/cframe0_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
cframe_bcast_reg.h This file contains confidential and proprietary information
of Xilinx, Inc. and is protected under U.S. and international copyright and
other intellectual property laws. DISCLAIMER This disclaimer is not a license
and does not grant any rights to the materials distributed herewith. Except as
otherwise provided in a valid license issued to you by Xilinx, and to the
maximum extent permitted by applicable law: (1) THESE MATERIALS ARE MADE
AVAILABLE "AS IS" AND WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT
LIMITED TO WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY
PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether in contract or
tort, including negligence, or under any other theory of liability) for any loss
or damage of any kind or nature related to, arising under or in connection with
these materials, including for any direct, or any indirect, special, incidental,
or consequential loss or damage (including loss of data, profits, goodwill, or
any type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/cframe_bcast_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
cfu_apb.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/cfu_apb.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
cpm_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/cpm_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
crf.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/crf.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
crl.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/crl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
crp.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/crp.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
efuse_cache.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/efuse_cache.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
fpd_apu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/fpd_apu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
lpd_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/lpd_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
pmc_analog.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/pmc_analog.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
pmc_dma0.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/pmc_dma0.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
pmc_dma1.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/pmc_dma1.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
pmc_global.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/pmc_global.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
pmc_iou_slcr.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/pmc_iou_slcr.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
pmc_tap.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/pmc_tap.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
psm_global_reg.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/psm_global_reg.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
rpu.h This file contains confidential and proprietary information of Xilinx,
Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/rpu.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-09-16 @file:
slave_boot.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_apps/versal_pmcfw/src/hw80/slave_boot.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file crf.h This file contains CRF
registers information <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 js 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/crf.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file crl.h This file contains CRL
registers information <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 js 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/crl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fpd_apu.h This file contains
FPD APU definitions used by PSM Firmware <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- -------- 1.00 rv 07/17/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/fpd_apu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ipi.h This file contains
definitions related to PSM IPI <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/ipi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file psm_global.h This file contains
PSM Global definitions used by PSM Firmware <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- -------- 1.00 rp 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/pmc_global.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file psm_global.h This file contains
PSM Global definitions used by PSM Firmware <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/psm_global.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file psm_local.h This file contains
PSM local registers information <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 ma 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/psm_local.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rpu.h This file contains RPU
register definitions used by PSM Firmware <pre> MODIFICATION HISTORY: Ver Who
Date Changes ---- ---- -------- 1.00 rv 07/17/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/rpu.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_config.h This file
contains user configuration for PSM Firmware <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 ma 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_debug.h This file
contains the debug verbose information for PSMFW print functionality <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018
Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_default.h This file
contains default headers and definitions used by PSM Firmware <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_default.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_init.c This
file contains PSM Firmware initialization functions <pre> MODIFICATION HISTORY:
Ver Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release
</pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_init.h This file
contains PSM Firmware initialization functions <pre> MODIFICATION HISTORY: Ver
Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre>
@note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_init.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_iomodule.c This file
contains IO Module interrupt handling functions <pre> MODIFICATION HISTORY: Ver
Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_iomodule.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_iomodule.h This file
contains IO Module definitions <pre> MODIFICATION HISTORY: Ver Who Date Changes
---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_iomodule.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_ipi_manager.c This file
contains IPI manager functions for PSM Firmware <pre> MODIFICATION HISTORY: Ver
Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre>
@note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_ipi_manager.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_ipi_manager.h This file
contains definitions for IPI manager <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_ipi_manager.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_main.c This
is the main file for PSM Firmware <pre> MODIFICATION HISTORY: Ver Who Date
Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_main.h This is the main
header file which contains definitions for PSM Firmware <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_main.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_power.c This file
contains power handler functions for PS Power islands and FPD <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- -------- 1.00 rp 07/13/2018 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_power.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_power.h This file
contains default headers and definitions used by Power module <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- -------- 1.00 rp 07/13/2018 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_power.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_reset.c <pre>
MODIFICATION HISTORY: Ver Who Date Changes ---- ---- -------- 1.00 rp 07/20/2018
Initial release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_reset.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_reset.h This file
contains default headers and definitions used by Reset module <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- -------- 1.00 rp 10/4/2018 Initial
release </pre> @note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_reset.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_util.c This file
contains read/write utilities for PSM Firmware <pre> MODIFICATION HISTORY: Ver
Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre>
@note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpsmfw_util.h This file
contains definitions for read/write utilities <pre> MODIFICATION HISTORY: Ver
Who Date Changes ---- ---- -------- 1.00 ma 04/09/2018 Initial release </pre>
@note

FILES:
lib/sw_apps/versal_psmfw/src/xpsmfw_util.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Includes /

FILES:
lib/sw_apps/xilkernel_thread_demo/src/main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

CAUTION: This file is automatically generated by HSI. Version: DO NOT EDIT. All
Rights Reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
Software), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED AS IS,
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: Configurations for
Standalone BSP

FILES:
lib/sw_apps/zynq_fsbl/misc/zc702/bspconfig.h
lib/sw_apps/zynq_fsbl/misc/zc706/bspconfig.h
lib/sw_apps/zynq_fsbl/misc/zed/bspconfig.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/bspconfig32.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102/bspconfig32.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE. @file ps7_init.c This file is automatically generated

FILES:
lib/sw_apps/zynq_fsbl/misc/zc702/ps7_init.c
lib/sw_apps/zynq_fsbl/misc/zc706/ps7_init.c
lib/sw_apps/zynq_fsbl/misc/zed/ps7_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ps7_init.h This
file can be included in FSBL code to get prototype of ps7_init() function and
error codes

FILES:
lib/sw_apps/zynq_fsbl/misc/zc702/ps7_init.h
lib/sw_apps/zynq_fsbl/misc/zc706/ps7_init.h
lib/sw_apps/zynq_fsbl/misc/zed/ps7_init.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file ps7_init_gpl.c This file is automatically
generated

FILES:
lib/sw_apps/zynq_fsbl/misc/zc702/ps7_init_gpl.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file ps7_init_gpl.h This file can be included in
FSBL code to get prototype of ps7_init() function and error codes

FILES:
lib/sw_apps/zynq_fsbl/misc/zc702/ps7_init_gpl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file ps7_init_gpl.c This file is automatically
generated

FILES:
lib/sw_apps/zynq_fsbl/misc/zc706/ps7_init_gpl.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file ps7_init_gpl.h This file can be included in
FSBL code to get prototype of ps7_init() function and error codes

FILES:
lib/sw_apps/zynq_fsbl/misc/zc706/ps7_init_gpl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file ps7_init_gpl.c This file is automatically
generated

FILES:
lib/sw_apps/zynq_fsbl/misc/zed/ps7_init_gpl.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file ps7_init_gpl.h This file can be included in
FSBL code to get prototype of ps7_init() function and error codes

FILES:
lib/sw_apps/zynq_fsbl/misc/zed/ps7_init_gpl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fsbl.h Contains the function
prototypes, defines and macros for the First Stage Boot Loader (FSBL)
functionality <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a jz 03/04/11 Initial release 2.00a mb 06/06/12 Removed the qspi
define, will be picked from xparameters.h file 3.00a np/mb 08/08/12 Added the
error codes for the FSBL hook errors. Added the debug levels 4.00a sgd 02/28/13
Removed DDR initialization check Removed DDR ECC initialization code Modified
hand off address check to 1MB Added RSA authentication support Removed
LPBK_DLY_ADJ register setting code as we use divisor 8 Removed check for Fabric
is already initialized CR's fixed and description 689026: FSBL doesn't hold PL
resets active during bit download Resolution: PL resets are released just before
handoff 689077: FSBL hangs at Handoff clearing the TX UART buffer Resolution:
STDOUT_BASEADDRESS macro value changes based UART select, hence used
STDOUT_BASEADDRESS as UART base address 695578: FSBL failed to load standalone
application in secure bootmode Resolution: Application will be placed at load
address instead of DDR temporary address 699475: FSBL functionality is broken
and its not able to boot in QSPI/NAND bootmode Resolution: New flags are added
DevCfg driver for handling loopback XDCFG_CONCURRENT_NONSEC_READ_WRITE
XDCFG_CONCURRENT_SECURE_READ_WRITE 683145: Define stack area for FIQ, UNDEF
modes in linker file Resolution: FSBL linker modified to create stack area for
FIQ, UNDEF 705664: FSBL fails to decrypt the bitstream when the image is AES
encrypted using non-zero key value Resolution: Fabric cleaning will not be done
for AES-E-Fuse encryption Watchdog disabled for AES E-Fuse encryption 5.00a sgd
05/17/13 Fallback support for E-Fuse encryption Added QSPI Flash Size > 128Mbit
support QSPI Dual Stack support Added Md5 checksum support CR's fixed and
description 692045 FSBL: Linker script of FSBL has PHDR workaround, this needs
to be fixed Resolution: Removed PHDR from Linker file 704287 FSBL: fsbl.h file
has a few error codes that are not used by FSBL, that needs to be removed
Resolution: Removed unused error codes 704379 FSBL: Check if DDR is in proper
state before handoff Resolution: Added DDR initialization check 709077 If
FSBL_DEBUG and FSBL_DEBUG_INFO are defined, the debug level is FSBL_DEBUG only.
710128 FSBL: Linux boot failing without load attribute set for Linux partitions
in BIF Resolution: FSBL will load partitions with valid load address and stop
loading if any invalid load address 708728 Issues seen while making HP
interconnect 32 bit wide Resolution: ps7_post_config function generated by PCW
will be called after Bit stream download Added MMC support 6.00a kc 07/31/2013
CR's fixed and description 724166 FSBL doesn’t use PPK authenticated by Boot
ROM for authenticating the Partition images Resolution: FSBL now uses the PPK
left by Boot ROM in OCM for authencating the SPK 724165 Partition Header used by
FSBL is not authenticated Resolution: FSBL now authenticates the partition
header 691150 ps7_init does not check for peripheral initialization failures or
timeout on polls Resolution: Return value of ps7_init() is now checked by FSBL
and prints the error string 708316 PS7_init.tcl file should have Error mechanism
for all mask_poll Resolution: Return value of ps7_init() is now checked by FSBL
and prints the error string 732062 FSBL fails to build if UART not available
Resolution: Added define to call xil_printf only if uart is defined 722979
Provide customer-friendly changelogs in FSBL Resolution: Added CR description
for all the files 732865 Backward compatibility for ps7_init function
Resolution: Added a new define for ps7_init success and value is defined based
on ps7_init define Fix for CR739711 - FSBL not able to read Large QSPI (512M) in
IO Mode Resolution: Modified the address calculation algorithm in dual parallel
mode for QSPI 7.00a kc 10/18/13 Integrated SD/MMC driver 10/23/13 Support for
armcc compiler added 741003 FSBL has to check the HMAC error status after
decryption Resolution: Added code for checking the error status after PCAP
completion 739968 FSBL should do the QSPI config settings for Dual parallel
configuration in IO mode Resolution: Added QSPI config settings in qspi.c 724620
FSBL: How to handle PCAP_MODE after bitstream configuration. Resolution:
PCAP_MODE and PCAP_PR bits are now cleared after PCAP transfer completion 726178
In the 14.6 FSBL function FabricInit() PROG_B is kept active for 5mS.
Resolution: PROG_B is now kept active for 5ms only in case if efuse is the aes
key source. 755245 FSBL does not load partition if eMMC has only one partition
Resolution: Changed the if condition for MMC 12/04/13 764382 FSBL: How to handle
PCAP_MODE after bitstream configuration Resolution: Reverted back the changes of
724620. PCAP_MODE and PCAP_PR bits are not changed 8.00a kc 01/16/13 767798 Fsbl
MD5 Checksum failiure for encrypted images Resolution: For checksum enabled
partitions, total total partition image length is copied now. 761895 FSBL should
authenticate image only if partition owner was not set to u-boot Resolution:
Partition owner check added in image_mover.c 02/20/14 775631 - FSBL:
FsblGetGlobalTimer() is not proper Resolution: Function argument is updated from
value to pointer to reflect updated value 9.00a kc 04/16/14 773866 - SetPpk()
will fail on secure fallback unless FSBL and FSBL are identical in length
Resolution: PPK is set only once now. 785778 - FSBL takes 8 seconds to
authenticate (RSA) a bitstream on zc706 Resolution: Data Caches are enabled only
for authentication. 791245 - Use of xilrsa in fsbl Resolution: Rsa library is
removed from fsbl source and xilrsa is used from BSP 10.00a kc 07/15/14 804595
Zynq FSBL - Issues with fallback image offset handling using MD5 Resolution:
Updated the checksum offset to add with image base address 782309 Fallback
support for AES encryption with E-Fuse - Enhancement Resolution: Same as 773866
809336 Minor code cleanup Resolution Minor code changes kc 08/27/14 820356 -
FSBL compilation fails with IAR compiler Resolution: Change of __asm__ to __asm
11.00a kv 10/08/14 826030 - FSBL:LinearBootDeviceFlag is not initialized in IO
mode case.Due to which the variable is remaining in unknown state. Resolution:
LinearBootDeviceFlag is initialized 0 in main.c 12.00a ssc 12/11/14 839182 -
FSBL -In the file sd.c, f_mount is called with two arguments but f_mount is
expecting the 3 arguments from build 2015.1_1210_1, causing compilation error.
Resolution: Arguments for f_mount in InitSD() are changed as per new signature.
13.00a ssc 04/10/15 846899 - FSBL -In the file pcap.c, to clear DMA done count,
devcfg.INT_STS register is written to, which is not correct. Resolution:
Corresponding fields in the devcfg.STATUS register are written to, for clearing
DMA done count. 14.00a gan 01/13/16 869081 -(2016.1)FSBL -In qspi.c, FSBL picks
the qspi read command from LQSPI_CFG register instead of hard coded read command
(0x6B). 15.00a gan 07/21/16 953654 -(2016.3)FSBL -In pcap.c/pcap.h/main.c,
Fabric Initialization sequence is modified to check the PL power before sequence
starts and checking INIT_B reset status twice in case of failure. 16.00a gan
08/02/16 Fix for CR 955897 -(2016.3)FSBL In pcap.c, check pl power through MCTRL
register for 3.0 and later versions of silicon. 17.00a bsv 27/03/18 Fix for CR
996973 Add code under JTAG_ENABLE_LEVEL_SHIFTERS macro to enable level shifters
in jtag boot mode. 18.00a ka 10/29/18 Fix for CR 1006294 Added macro for
FORCE_USE_AES_EXCLUDE </pre> </pre> @note Flags in FSBL FSBL_PERF This Flag can
be set at compilation time. This flag is set for measuring the performance of
FSBL.That is the time taken to execute is measured.when this flag is
set.Execution time with reference to global timer is taken here Total Execution
time is the time taken for executing FSBL till handoff to any application . If
there is a bitstream in the partition header then the execution time includes
the copying of the bitstream to DDR (in case of SD/NAND bootmode) and
programming the devcfg dma is accounted. FSBL provides two debug levels DEBUG
GENERAL - fsbl_printf under this category will appear only when the FSBL_DEBUG
flag is set during compilation DEBUG_INFO - fsbl_printf under this category will
appear when the FSBL_DEBUG_INFO flag is set during compilation For a more
detailed output log can be used. FSBL_DEBUG_RSA - Define this macro to print
more detailed values used in RSA functions These macros are input to the
fsbl_printf function DEBUG LEVELS FSBL_DEBUG level is level 1, when this flag is
set all the fsbl_prints that are with the DEBUG_GENERAL argument are shown
FSBL_DEBUG_INFO is level 2, when this flag is set during the compilation , the
fsbl_printf with DEBUG_INFO will appear on the com port DEFAULT LEVEL By default
no print messages will appear. NON_PS_INSTANTIATED_BITSTREAM FSBL will not
enable the level shifters for a NON PS instantiated Bitstream.This flag can be
set during compilation for a NON PS instantiated bitstream ECC_ENABLE This flag
will be defined in the ps7_init.h file when ECC is enabled in the DDR
configuration (XPS GUI) RSA_SUPPORT This flag is used to enable authentication
feature Default this macro disabled, reason to avoid increase in code size
MMC_SUPPORT This flag is used to enable MMC support feature
JTAG_ENABLE_LEVEL_SHIFTERS FSBL will not enable the level shifters for jtag boot
mode. This flag can be set during compilation for jtag boot mode to enable level
shifters. FORCE_USE_AES_EXCLUDE Defining this flag will exclude the feature,
forcing every partition to be encrypted when EFUSE_SEC_EN bit is set. This flag
can be set/unset during compilation. By default this flag is unset/undefined
which enables the above feature Note : Changing the default behaviour is not
recommended from Security perspective.

FILES:
lib/sw_apps/zynq_fsbl/src/fsbl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fsbl_debug.h This file contains
the debug verbose information for FSBL print functionality <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 3.00a mb 01/09/12 Initial
release </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/fsbl_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fsbl_hooks.c This file provides
functions that serve as user hooks. The user can add the additional
functionality required into these routines. This would help retain the normal
FSBL flow unchanged. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 3.00a np 08/03/12 Initial release </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/fsbl_hooks.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file fsbl_hooks.h Contains the
function prototypes, defines and macros required by fsbl_hooks.c <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 3.00a np/mb
10/08/12 Initial release Corrected the prototype </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/fsbl_hooks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file image_mover.c Move partitions
to either DDR to execute or to program FPGA. It performs partition walk. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 05/24/11
Initial release 2.00a jz 06/30/11 Updated partition header defs for 64-byte
alignment change in data2mem tool 2.00a mb 05/25/12 Updated for standalone based
bsp FSBL Nand/SD encryption and review comments 3.00a np 08/30/12 Added FSBL
user hook calls (before and after bitstream download.) 4.00a sgd 02/28/13 Fix
for CR691148 Secure bootmode error in devcfg test Fix for CR695578 FSBL failed
to load standalone application in secure bootmode 4.00a sgd 04/23/13 Fix for
CR710128 FSBL failed to load standalone application in secure bootmode 5.00a kc
07/30/13 Fix for CR724165 Partition Header used by FSBL is not authenticated Fix
for CR724166 FSBL doesn�t use PPK authenticated by Boot ROM for authenticating
the Partition images Fix for CR732062 FSBL fails to build if UART not available
7.00a kc 10/30/13 Fix for CR755245 FSBL does not load partition if eMMC has only
one partition 8.00a kc 01/16/13 Fix for CR767798 FSBL MD5 Checksum failure for
encrypted images Fix for CR761895 FSBL should authenticate image only if
partition owner was not set to u-boot 9.00a kc 04/16/14 Fix for CR785778 FSBL
takes 8 seconds to authenticate (RSA) a bitstream on zc706 10.00a kc 07/15/14
Fix for CR804595 Zynq FSBL - Issues with fallback image offset handling using
MD5 Fix for PR782309 Fallback support for AES encryption with E-Fuse -
Enhancement 11.00a ka 10/12/18 Fix for CR1006294 Zynq FSBL - Zynq FSBL does not
check USE_AES_ONLY eFuse </pre> @note A partition is either an executable or a
bitstream to program FPGA Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/image_mover.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file image_mover.h This file
contains the interface for moving the image from FLASH to OCM <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a jz 03/04/11 Initial
release 2.00a jz 06/04/11 partition header expands to 12 words 5.00a kc 07/30/13
Added defines for image header information 8.00a kc 01/16/13 Added defines for
partition owner attribute </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/image_mover.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file main.c The main file for the
First Stage Boot Loader (FSBL). <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a jz 06/04/11 Initial release 2.00a mb 25/05/12
standalone based FSBL 3.00a np/mb 08/03/12 Added call to FSBL user hook - before
handoff. DDR ECC initialization added fsbl print with verbose added Performance
measurement added Flushed the UART Tx buffer Added the performance time for ECC
DDR init Added clearing of ECC Error Code Added the watchdog timer value 4.00a
sgd 02/28/13 Code Cleanup Fix for CR681014 - ECC init in FSBL should not call
fabric_init() Fix for CR689077 - FSBL hangs at Handoff clearing the TX UART
buffer when using UART0 instead of UART1 Fix for CR694038 - FSBL debug logs
always prints 14.3 as the Revision number - this is incorrect Fix for CR694039 -
FSBL prints "unsupported silicon version for v3.0" 3.0 Silicon Fix for CR699475
- FSBL functionality is broken and its not able to boot in QSPI/NAND bootmode
Removed DDR initialization check Removed DDR ECC initialization code Modified
hand off address check to 1MB Added RSA authentication support Watchdog disabled
for AES E-Fuse encryption 5.00a sgd 05/17/13 Fallback support for E-Fuse
encryption Fix for CR708728 - Issues seen while making HP interconnect 32 bit
wide 6.00a kc 07/30/13 Fix for CR708316 - PS7_init.tcl file should have Error
mechanism for all mask_poll Fix for CR691150 - ps7_init does not check for
peripheral initialization failures or timeout on polls Fix for CR724165 -
Partition Header used by FSBL is not authenticated Fix for CR724166 - FSBL
doesn’t use PPK authenticated by Boot ROM for authenticating the Partition
images Fix for CR722979 - Provide customer-friendly changelogs in FSBL Fix for
CR732865 - Backward compatibility for ps7_init function 7.00a kc 10/18/13
Integrated SD/MMC driver 8.00a kc 02/20/14 Fix for CR775631 - FSBL:
FsblGetGlobalTimer() is not proper 9.00a kc 04/16/14 Fix for CR724166 - SetPpk()
will fail on secure fallback unless FSBL and FSBL are identical in length 10.00a
kc 07/24/14 Fix for CR809336 - Minor code cleanup kc 08/27/14 Fix for CR820356 -
FSBL compilation fails with IAR compiler 11.00a kv 10/08/14 Fix for CR826030 -
LinearBootDeviceFlag should be initialized to 0 in IO mode case 15.00a gan
07/21/16 Fix for CR 953654 -(2016.3)FSBL In pcap.c/pcap.h/main.c, Fabric
Initialization sequence is modified to check the PL power before sequence starts
and checking INIT_B reset status twice in case of failure. 16.00a bsv 03/26/18
Fix for CR 996973 Add code under JTAG_ENABLE_LEVEL_SHIFTERS macro to enable
level shifters in jtag boot mode. </pre> @note FSBL runs from OCM, Based on the
boot mode selected, FSBL will copy the partitions from the flash device. If the
partition is bitstream then the bitstream is programmed in the Fabric and for an
partition that is an application , FSBL will copy the application into DDR and
does a handoff.The application should not be starting at the OCM address, FSBL
does not remap the DDR. Application should use DDR starting from 1MB FSBL can be
stitched along with bitstream and application using bootgen Refer to fsbl.h file
for details on the compilation flags supported in FSBL Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/main.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [BSD] [BSD-3] [BSD-2]

COPYRIGHT TEXT:
---------------

Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) All rights reserved. This
package is an SSL implementation written by Eric Young (eay@cryptsoft.com). The
implementation was written so as to conform with Netscapes SSL. This library is
free for commercial and non-commercial use as long as the following conditions
are adhered to. The following conditions apply to all code found in this
distribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code.
The SSL documentation included with this distribution is covered by the same
copyright terms except that the holder is Tim Hudson (tjh@cryptsoft.com).
Copyright remains Eric Young's, and as such any Copyright notices in the code
are not to be removed. If this package is used in a product, Eric Young should
be given attribution as the author of the parts of the library used. This can be
in the form of a textual message at program startup or in documentation (online
or textual) provided with the package. Redistribution and use in source and
binary forms, with or without modification, are permitted provided that the
following conditions are met: 1. Redistributions of source code must retain the
copyright notice, this list of conditions and the following disclaimer. 2.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution. 3. All advertising materials
mentioning features or use of this software must display the following
acknowledgement: "This product includes cryptographic software written by Eric
Young (eay@cryptsoft.com)" The word 'cryptographic' can be left out if the
routines from the library being used are not cryptographic related :-). 4. If
you include any Windows specific code (or a derivative thereof) from the apps
directory (application code) you must include an acknowledgement: "This product
includes software written by Tim Hudson (tjh@cryptsoft.com)" THIS SOFTWARE IS
PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE. The licence and distribution terms for any publicly available
version or derivative of this code cannot be changed. i.e. this code cannot
simply be copied and put under another distribution licence [including the GNU
Public Licence.] / @file md5.c Contains code to calculate checksum using md5
algorithm <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
5.00a sgd 05/17/13 Initial release </pre> @note Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/md5.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file md5.h <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 5.00a sgd 05/17/13 Initial
release </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/md5.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file nand.c Contains code for the
NAND FLASH functionality. Bad Block management is simple: skip the bad blocks
and keep going. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ecm 01/10/10 Initial release 2.00a mb 25/05/12 fsbl changes for
standalone bsp based 3.00a sgd 30/01/13 Code cleanup 5.00a sgd 17/05/13 Support
for Multi Boot </pre> @note Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/nand.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file nand.h This file contains the
interface for the NAND FLASH functionality <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a ecm 01/10/10 Initial release 2.00a mb
30/05/12 added the flag XPAR_PS7_NAND_0_BASEADDR 10.00a kc 08/04/14 Fix for
CR809336 - Removed smc.h </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/nand.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file nor.c Contains code for the NOR
FLASH functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a ecm 01/10/10 Initial release 2.00a mb 25/05/12 mio init removed
3.00a sgd 30/01/13 Code cleanup </pre> @note Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/nor.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file nor.h This file contains the
interface for the NOR FLASH functionality <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a ecm 01/10/10 Initial release 10.00a kc
08/04/14 Fix for CR809336 - Removed smc.h </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/nor.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pcap.c Contains code for
enabling and accessing the PCAP <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00a ecm 02/10/10 Initial release 2.00a jz 05/28/11 Add SD
support 2.00a mb 25/05/12 using the EDK provided devcfg driver Nand/SD
encryption and review comments 3.00a mb 16/08/12 Added the poll function Removed
the FPGA_RST_CTRL define Added the flag for NON PS instantiated bitstream 4.00a
sgd 02/28/13 Fix for CR681014 - ECC init in FSBL should not call fabric_init()
Fix for CR689026 - FSBL doesn't hold PL resets active during bit download Fix
for CR699475 - FSBL functionality is broken and its not able to boot in
QSPI/NAND bootmode Fix for CR705664 - FSBL fails to decrypt the bitstream when
the image is AES encrypted using non-zero key value 6.00a kc 08/30/13 Fix for
CR722979 - Provide customer-friendly changelogs in FSBL 7.00a kc 10/25/13 Fix
for CR724620 - How to handle PCAP_MODE after bitstream configuration Fix for
CR726178 - FabricInit() PROG_B is kept active for 5mS. Fix for CR731839 - FSBL
has to check the HMAC error status after decryption 12/04/13 Fix for CR764382 -
How to handle PCAP_MODE after bitstream configuration - PCAP_MODE and PCAP_PR
bits are not modified 8.00a kc 2/20/14 Fix for CR775631 - FSBL:
FsblGetGlobalTimer() is not proper 10.00a kc 07/24/14 Fix for CR809336 - Minor
code cleanup 13.00a ssc 04/10/15 Fix for CR846899 - Corrected logic to clear DMA
done count 15.00a gan 07/21/16 Fix for CR 953654 -(2016.3)FSBL In
pcap.c/pcap.h/main.h, Fabric Initialization sequence is modified to check the PL
power before sequence starts and checking INIT_B reset status twice in case of
failure. 16.00a gan 08/02/16 Fix for CR 955897 -(2016.3)FSBL In pcap.c, check pl
power through MCTRL register for 3.0 and later versions of silicon. </pre> @note
Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/pcap.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pcap.h This file contains the
interface for intiializing and accessing the PCAP <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a ecm 02/10/10 Initial release
2.00a mb 16/08/12 Added the macros and function prototypes 15.00a gan 07/21/16
953654 -(2016.3)FSBL -In pcap.c/pcap.h/main.c, Fabric Initialization sequence is
modified to check the PL power before sequence starts and checking INIT_B reset
status twice in case of failure. </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/pcap.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ps7_init.c This file is
automatically generated

FILES:
lib/sw_apps/zynq_fsbl/src/ps7_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file ps7_init.h This file can be
included in FSBL code to get prototype of ps7_init() function and error codes

FILES:
lib/sw_apps/zynq_fsbl/src/ps7_init.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file qspi.c Contains code for the
QSPI FLASH functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a ecm 01/10/10 Initial release 3.00a mb 25/06/12 InitQspi,
data is read first and required config bits are set 4.00a sg 02/28/13 Cleanup
Removed LPBK_DLY_ADJ register setting code as we use divisor 8 5.00a sgd
05/17/13 Added Flash Size > 128Mbit support Dual Stack support Fix for CR:721674
- FSBL- Failed to boot from Dual stacked QSPI 6.00a kc 08/30/13 Fix for CR722979
- Provide customer-friendly changelogs in FSBL Fix for CR739711 - FSBL not able
to read Large QSPI (512M) in IO Mode 7.00a kc 10/25/13 Fix for CR739968 - FSBL
should do the QSPI config settings for Dual parallel configuration in IO mode
14.0 gan 01/13/16 Fix for CR869081 - (2016.1)FSBL picks the qspi read command
from LQSPI_CFG register instead of hard coded read command (0x6B). </pre> @note
Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/qspi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file qspi.h This file contains the
interface for the QSPI FLASH functionality <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a ecm 01/10/10 Initial release 3.00a mb
01/09/12 Added the Delay Values defines for qspi 5.00a sgd 05/17/13 Added Flash
Size > 128Mbit support Dual Stack support </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/qspi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rsa.c Contains code for the RSA
authentication <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 4.00a sgd 02/28/13 Initial release 6.00a kc 07/30/13 Added
FSBL_DEBUG_RSA to print more RSA buffers Fix for CR724165 - Partition Header
used by FSBL is not authenticated Fix for CR724166 - FSBL doesn’t use PPK
authenticated by Boot ROM for authenticating the Partition images Fix for
CR722979 - Provide customer-friendly changelogs in FSBL 9.00a kc 04/16/14 Fix
for CR724166 - SetPpk() will fail on secure fallback unless FSBL and FSBL are
identical in length Fix for CR791245 - Use of xilrsa in FSBL </pre> @note
Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/rsa.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file rsa.h This file contains the
RSA algorithm functions <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 4.00a sg 02/28/13 Initial release </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/rsa.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sd.c Contains code for the SD
card FLASH functionality. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a jz 04/28/11 Initial release 7.00a kc 10/18/13 Integrated
SD/MMC driver 12.00a ssc 12/11/14 Fix for CR 839182 </pre> @note Include Files /

FILES:
lib/sw_apps/zynq_fsbl/src/sd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file sd.h This file contains the
interface for the Secure Digital (SD) card <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a bh 03/10/11 Initial release 7.00a kc
10/18/13 Integrated SD/MMC driver </pre> @note

FILES:
lib/sw_apps/zynq_fsbl/src/sd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmt_common.c This file
contains code for common functions which are used by Read/Write Eye tests and
the Memory Tests. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 mn 08/17/18 Initial release mn 09/21/18 Modify code manually enter
the DDR memory test size mn 09/27/18 Modify code to add 2D Read/Write Eye Tests
support mn 12/17/18 Limit VRefMin to minimum of 0 for 2D eye scan mn 07/01/19
Add support to specify number of iteration for memtest </pre> @note / Include
Files /

FILES:
lib/sw_apps/zynqmp_dram_test/src/xmt_common.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmt_common.h This is the
header file containing all the Global defines and function declarations for
ZynqMP DRAM Test. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 mn 08/17/18 Initial release mn 09/27/18 Modify code to add 2D
Read/Write Eye Tests support </pre> @note /

FILES:
lib/sw_apps/zynqmp_dram_test/src/xmt_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmt_main.c This is the main
file for ZynqMP DRAM test. This includes various DRAM tests like Memory Tests of
different sizes, Read Eye test and Write Eye test. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 mn 08/17/18 Initial release mn
09/21/18 Modify code manually enter the DDR memory test size mn 09/27/18 Modify
code to add 2D Read/Write Eye Tests support mn 04/09/19 Add check for Carriage
return when entering the test size mn 07/01/19 Add support to specify number of
iteration for memtest </pre> @note / Include Files /

FILES:
lib/sw_apps/zynqmp_dram_test/src/xmt_main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmt_read_eye.c This is the
file containing code for DDR Read Eye Tests. This measures Right Eye Edge, Left
Eye Edge, Read Eye Width, Taps per Cycle and Read Eye Center. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 mn 08/17/18 Initial
release mn 09/27/18 Modify code to add 2D Read/Write Eye Tests support </pre>
@note / Include Files /

FILES:
lib/sw_apps/zynqmp_dram_test/src/xmt_read_eye.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xmt_write_eye.c This is the
file containing code for DDR Write Eye Tests. This measures Right Eye Edge, Left
Eye Edge, Write Eye Width, Taps per Cycle and Write Eye Center. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 mn 08/17/18
Initial release mn 09/27/18 Modify code to add 2D Read/Write Eye Tests support
</pre> @note / Include Files /

FILES:
lib/sw_apps/zynqmp_dram_test/src/xmt_write_eye.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file psu_init.c This
file is automatically generated

FILES:
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/psu_init.c
lib/sw_apps/zynqmp_fsbl/misc/zcu102/psu_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file psu_init.h This
file is automatically generated

FILES:
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/psu_init.h
lib/sw_apps/zynqmp_fsbl/misc/zcu102/psu_init.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/>

FILES:
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/psu_init_gpl.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file psu_init_gpl.h This file is automatically
generated

FILES:
lib/sw_apps/zynqmp_fsbl/misc/zcu102-es2/psu_init_gpl.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/>

FILES:
lib/sw_apps/zynqmp_fsbl/misc/zcu102/psu_init_gpl.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [GPL] [Free-Software-Foundation]

COPYRIGHT TEXT:
---------------

All rights reserved. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your
option) any later version. This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, see
<http://www.gnu.org/licenses/> @file psu_init_gpl.h This file is automatically
generated

FILES:
lib/sw_apps/zynqmp_fsbl/misc/zcu102/psu_init_gpl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_authentication.c Contains
the function definitions for RSA Signature verification. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 ssc 01/20/16 Initial
release 2.0 bv 12/05/16 Made compliance to MISRAC 2012 guidelines. vns 02/17/17
Added PPK hash and SPK ID verification when eFUSE RSA authentication is enabled
3.0 vns 09/08/17 Added PPK revoke check. 4.0 vns 01/23/18 Added KECCAK SHA3
padding selection for SPK signature verification and PPK hash caclulation,
however partition will be authenticated with NIST SHA3 padding vns 03/07/18
Added API to do boot header authentication, removed PPK verification for every
partition instead saving PPK key at the time of boot header authentication,
Modified XFsbl_PpkSpkIdVer to XFsbl_PpkVer which takes care of PPK revocation
checks as well and Modified XFsbl_ReadPpkHashSpkID to XFsbl_ReadPpkHash as SPK
ID reading and verification moved to XFsbl_SpkVer. 5.0 ka 04/10/18 Added support
for user-efuse revocation 6.0 vns 03/12/19 Modified function call
XSecure_RsaDecrypt to XSecure_RsaPublicEncrypt, as XSecure_RsaDecrypt is
deprecated. </pre> Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_authentication.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcbr_authentication.h Contains
the function prototypes, defines and macros for the RSA DSA functionality. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 ssc 01/20/16
Initial release 2.0 bv 12/05/16 Made compliance to MISRAC 2012 guidelines. vns
02/17/17 Added API prototype to compare hashes 3.0 vns 01/23/18 Added prototype
for XFsbl_Sha3PadSelect() vns 03/07/18 Added PPK/SPK offsets w.r.t to AC,
modified prototype of XFsbl_CompareHashs() 4.0 ka 04/10/18 Added support for
user-efuse revocation </pre>

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_authentication.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_board.c This file
contains board specific code of FSBL. Board specific code for ZCU106 is similar
to that of ZCU102, except that GT mux configuration and PCIe reset are not
applicable for ZCU106. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 ssc 01/20/16 Initial release 2.0 bv 12/05/16 Made compliance
to MISRAC 2012 guidelines Added ZCU106 support 3.0 bkm 18/4/18 Added Board
specific code w.r.t VADJ </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_board.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_board.h This is the
header file which contains board specific definitions for FSBL. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 ssc 01/20/16
Initial release 2.0 bv 12/05/16 Made compliance to MISRAC 2012 guidelines Added
ZCU106 support 3.0 bkm 18/4/18 Added Board specific code w.r.t VADJ </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_board.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xfsbl_bs.c This file contains
the definitions of bitstream loading functions. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 ba 11/17/14 Initial release 2.0 bv
12/05/16 Made compliance to MISRAC 2012 guidelines Chunk for bitstream is been
storing at bitstream_buffer section </pre> @note / Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_bs.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_bs.h This is the header
file which contains definitions for the PCAP hardware registers and declarations
of bitstream download functions <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 ba 11/17/14 Initial release 2.0 bv 12/05/16 Made
compliance to MISRAC 2012 guidelines Modified bitstream chunk size to 56KB
</pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_bs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_config.h This is the
header file which contains FSBL configuration for users. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial
release 2.0 vns 03/24/17 Removed READ_BUFFER_SIZE from configuration Added
FSBL_PL_CLEAR_EXCLUDE_VAL, FSBL_USB_EXCLUDE_VAL, FSBL_PROT_BYPASS_EXCLUDE_VAL
configurations 3.0 vns 03/07/18 Added FSBL_FORCE_ENC_EXCLUDE_VAL configuration
</pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_csu_dma.c Contains code
for the CSU DMA initialization <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 07/22/14 Initial release 2.0 bv 12/05/16 Made
compliance to MISRAC 2012 guidelines </pre> @note / Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_csu_dma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xcbr_csu_dma.h Contains
declarations for CSU DMA initialization <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 07/22/14 Initial release 2.0 bv 01/29/17
XFSBL_CSU_SSS_SRC_DEST_DMA and XFSBL_CSU_SSS_DMA_MASK masks </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_csu_dma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xfsbl_ddr_init.c This is the
file which contains initialization code for the DDR. This code is used for all
the ZynqMP boards. This code will identify the DDR DIMM part by fetching SPD
data from EEPROM of the DIMM on run time and Initialize the same. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 mn 07/06/18
Add DDR initialization support for new DDR DIMM part mn 07/18/18 Move iicps.h
inclusion under ZCU102 and ZCU106 macro checks 2.0 mn 02/28/19 Add Dynamic DDR
initialization support for all DDR DIMMs mn 03/12/19 Select EEPROM Lower Page
for reading SPD data </pre> @note / Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_ddr_init.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xfsbl_ddr_init.h This is the
file which contains definition for initialization function for the DDR. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 mn 07/06/18
Add DDR initialization support for new DDR DIMM part mn 07/30/18 Define some DDR
registers addresses if not defined 2.0 mn 02/28/19 Add Dynamic DDR
initialization support for all DDR DIMMs </pre> @note /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_ddr_init.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_debug.h This file
contains the debug verbose information for FSBL print functionality <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a kc 11/05/13
Initial release 2.0 bv 12/05/16 Made compliance to MISRAC 2012 guidelines </pre>
@note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xfsbl_dfu_util.c This file
contains definitions of the DFU specific functions to be used in USB boot mode.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 bvikram
02/01/17 First release </pre>

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_dfu_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_dfu_util.h This file
contains declarations of the DFU specific functions and structures to be used in
USB boot mode. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 bvikram 02/01/17 First release </pre>

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_dfu_util.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_error.h This is the
header file which contains error codes for the FSBL. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 2.0 bv
12/05/16 Made compliance to MISRAC 2012 guidelines 03/24/17 Added new error
codes. 3.0 vns 09/08/17 Added error code for PPK revoke failure 4.0 vns 03/07/18
Added error codes for boot header authentication failure and for encryption
compulsory 5.0 ka 04/10/18 Added error codes for user-efuse revocation 6.0 bkm
04/10/18 Added error codes for FMC_VADJ </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_error.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_handoff.c This is the
main file which contains handoff code for the FSBL. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 2.0 bv
12/05/16 Made compliance to MISRAC 2012 guidelines vns Added support for HIVEC.
bo 01/25/17 During handoff again R5 is restored to LOVEC. sc 02/04/17 Lock
XMPU/XPPU for further access but by default it is by passed. bv 03/17/17
Modified such that XFsbl_PmInit is done only duing system reset </pre> @note /
Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_handoff.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_hooks.c This is the file
which contains FSBL hook functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 04/21/14 Initial release 2.0 bv 12/05/16
Made compliance to MISRAC 2012 guidelines ssc 03/25/17 Set correct value for
SYSMON ANALOG_BUS register </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_hooks.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_hooks.h This is the
header file which contains definitions for the FSBL hooks <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial
release </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_hooks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_hw.h This is the header
file which contains definitions for the hardware registers. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial
release 2.0 bv 12/05/16 Made compliance to MISRAC 2012 guidelines 3.0 vns
09/08/17 Added eFUSE secure control register masks for PPK revoke 4.0 vns
02/02/18 Added warning message to notify SHA2 support deprecation in future
releases. vns 03/07/18 Added ENC_ONLY mask 4.0 vns 03/14/19 Added AES reset
offset and Mask values. </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_image_header.c This is
the image header C file which does validation for the image header. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13
Initial release 2.0 bv 12/05/16 Made compliance to MISRAC 2012 guidelines vns
01/28/17 Added API for XFsbl_GetVectorLocation and XFsbl_GetBlockSize bv
02/11/17 Added warmrestart support, based on which partition header is
validated. vns 02/17/17 If authentication is enabled whole image header is been
validated by copying to OCM. Updated destination CPU for PMUFW. 3.0 vns 03/07/18
All the partitions should be encrypted when ENC_ONLY eFUSE bit is set, if not
encrypted FSBL throw an error. mus 02/26/19 Added support for armclang compiler
bsv 07/05/19 Remove MD5 checksum related code </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_image_header.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_image_header.h This is
the image header file which contains definitions for the image header. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13
Initial release 2.0 bv 12/05/16 Made compliance to MISRAC 2012 guidelines vns
01/20/17 Added XIH_PH_ATTRB_VEC_LOCATION_MASK, XIH_PH_ATTRB_DEST_CPU_PMU
XIH_PH_ATTRB_VEC_LOCATION_SHIFT masks and APIs XFsbl_GetVectorLocation(),
XFsbl_GetBlockSize() Added Offsets of image header's Partition header, AC, and
SPKID and PPK select masks. bv 03/17/17 Modified XFsbl_ValidatePartitionHeader
API to have parameter for ResetType 3.0 vns 01/03/18 In structure
XFsblPs_PartitionHeader 8 bits from reserved bits are used for storing last 8
bits of IV IV from boot header should be added with thes 8 bits. vns 03/07/18
Added BHDR attribute mask for PUF and macros for boot header size. bsv 07/05/19
Remove MD5 checksum related macro </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_image_header.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xfsbl_initilization.c This is
the file which contains initialization code for the FSBL. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial
release 2.00 sg 13/03/15 Added QSPI 32Bit bootmode 3.0 bv 12/02/16 Made
compliance to MISRAC 2012 guidelines 12/08/16 Added PL clear at initialization
based on user configuration 01/25/17 Updated R5 TCM with lovec value in
XFsbl_ProcessorInit and XFsbl_TcmEccInit is been updated such that R5_L and R5_0
don't initialize initial 32 bytes of TCM as they are holding R5 vectors bv
01/29/17 Added USB boot mode initializations 02/11/17 Add APU only reset code.
vns 02/17/17 Added image header authentication bv 03/17/17 Based on reset reason
initializations of system, tcm etc is done. vns 04/04/17 Corrected image header
size. ma 05/10/17 Enable PROG to PL when reset reason is ps-only reset 4.0 vns
03/07/18 Added boot header authentication, attributes reading from boot header
local buffer, copying IV to global variable for using during decryption of
partition. 5.0 mn 07/06/18 Add DDR initialization support for new DDR DIMM part
mus 02/26/19 Added support for armclang compiler vns 03/14/19 Setting AES and
SHA hardware engines into reset. </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_initialization.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_main.c This is the main
file which contains code for the FSBL. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 1.00 ba 02/22/16
Added performance measurement feature. 2.0 bv 12/02/16 Made compliance to MISRAC
2012 guidelines Added warm restart support </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_main.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_main.h This is the main
header file which contains definitions for the FSBL. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 2.0 vb
03/24/17 Added macros for LOVEC/HIVEC and USB boot mode, Made compliance to
MISRAC 2012 guidelines </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_main.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_common.c This is the file
which contains common code for the FSBL. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 2.0 bv
12/02/16 Made compliance to MISRAC 2012 guidelines vns 01/29/17 Added API
XFsbl_AdmaCopy to transfer data using ADMA </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_misc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_common.c This is the file
which contains common code for the FSBL. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 2.0 bv
12/02/16 Made compliance to MISRAC 2012 guidelines </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_misc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_misc_drivers.c This is
the header file which contains definitions for wrapper functions for WDT, CSUDMA
drivers <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00 kc 10/21/13 Initial release 2.0 bv 12/02/16 Made compliance to MISRAC 2012
guidelines jr 01/24/17 Updated XFsbl_PmInit function, to process only SYSCFG is
enabled and sending PM_SET_CONFIGURATION API to the PMU 3.0 bv 08/04/18 Call
XWdts_Stop only when WDT timer is in ready state </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_misc_drivers.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_misc_drivers.h This is
the header file which contains declarations for wrapper functions for WDT,
CSUDMA drivers <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 kc 10/21/13 Initial release 2.0 bv 12/02/16 Made compliance to
MISRAC 2012 guidelines </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_misc_drivers.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_nand.c This is the file
which contains nand related code for the FSBL. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 04/21/14 Initial release </pre>
@note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_nand.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_partition_load.c This is
the file which contains partition load code for the FSBL. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial
release 2.0 bv 12/02/16 Made compliance to MISRAC 2012 guidelines bo 01/25/17
Fixed Vector regions overwritten in R5 FSBL vns 03/01/17 Enhanced security of
bitstream authentication Modified endianness of IV as APIs are modified in
Xilsecure While loading bitstream clearing of PL is skipped when PL is already
cleared at initialize. Updated destination cpu for PMUFW. bv 03/20/17 Removed
isolation in PS - PL AXI bus thus allowing access to BRAM in PS only reset vns
04/04/17 Corrected IV location w.r.t Image offset. 3.0 vns 01/03/18 Modified
XFsbl_PartitionValidation() API, for each partition by adding IV of LSB 8 bits
with 8 bits of IV from XFsblPs_PartitionHeader structure. vns 03/07/18 Iv
copying is limited to only once from boot header, and is used for every
partition, In authentication case we are using IV from authenticated
header(copied to internal memory), using same way for non authenticated case as
well. mus 02/26/19 Added support for armclang compiler. </pre> @note Include
Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_partition_load.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_plpartition_valid.c
Contains the function definitions of bitstream authentication in blocks. As we
need to decrypt the authenticated data only and for secure reasons data should
not be on external memory authenticated data bitstream of MBs cannot be stored
in OCM as we have limited OCM memory. In boot image bitstream is placed in
blocks of size 8MB so bitstream will be authenticated in blocks by copying each
time 32KB chunk to OCM, and each chunk's hash will be stored in OCM buffer for
the current block. Once authentication of the block is completed successfully,
again each chunk of the block will be read from external memory and calculates
hash on chunk and compares with the stored hash. If matched each chunk will be
sent to AES if decryption exists or to PCAP throught CSUDMA. The above process
will be repeated for all the blocks of bitstream. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 1.0 vns 01/28/17 First release 2.0
vns 11/09/17 Modified recursive function call to while loop, added code for
handling the decryption of bitstream when secure header of block is divided in
two chunks, by copying partial secure header to a buffer and then processing it
along with next chunk of data where it holds remaining secure header. 3.0 vns
01/03/18 Modified XFsbl_DecrptPlChunks() API, to use key IV from secure header
to decrypt the secure bitstream. vns 01/23/18 Removed SSS switch configuring for
every SHA3 update as now library is configuring switch before every DMA
transfer. vns 03/07/18 Removed PPK verification for bitstream partition as APIs
are modified to verify SPK with already verified PPK 4.0 vns 03/12/19 Modified
function call XSecure_RsaDecrypt to XSecure_RsaPublicEncrypt, as
XSecure_RsaDecrypt is deprecated, also calls to secure stream switch are
modified </pre> Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_plpartition_valid.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_plpartition_valid.h
Contains constant definitions for bitstream authentication. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 vns 01/28/17 First
release 2.0 vns 11/09/17 In structure XFsblPs_PlPartition added member
(SecureHdr) to store partial secure header when single secure header is in two
chunks, also added another member(Hdr) to store size of data stored. 3.0 vns
03/12/19 Added instance to XSecure_Sss structure in XFsblPs_PlPartition
structure. </pre>

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_plpartition_valid.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_qspi.c This is the file
which contains qspi related code for the FSBL. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 2.00 sg
12/03/15 Added GQSPI driver support 32Bit boot mode support 3.0 bv 12/02/16 Made
compliance to MISRAC 2012 guidelines ds 01/03/17 Add support for Micron QSPI 2G
part 4.0 tjs 10/16/18 Added support for QPI mode in Macronix flash parts. sk
03/13/19 Added dual parallel support and QPI support for 24bit boot mode for
Macronix flash parts. </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_qspi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_qspi.h This is the header
file which contains qspi declarations for the FSBL. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 10/21/13 Initial release 2.00
sg 12/03/15 Added GQSPI driver support 32Bit boot mode support 3.0 ds 01/03/17
Add support for Micron QSPI 2G part </pre> @note

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_qspi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_rsa_sha.c This contains
code for the RSA and SHA functionality. If the Hash type is SHA3 then CSU h/w
will be used else we will use SoftSHA256 s/w library for SHA2-256. For RSA-4096
we will always use CSU h/w. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 07/22/14 Initial release 2.0 bv 12/02/16 Made
compliance to MISRAC 2012 guidelines 3.0 vns 01/23/18 Added
XFsbl_Sha3PadSelect() API to change SHA3 padding to KECCAK SHA3 padding. </pre>
@note / Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_rsa_sha.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_sd.c This is the file
which contains sd related code for the FSBL. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 04/21/14 Initial release 2.0 bv
12/02/16 Made compliance to MISRAC 2012 guidelines </pre> @note Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_sd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_usb.c This file contains
definitions of the generic handler functions to be used in USB boot mode. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 bvikram
02/01/17 First release </pre> Include Files /

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_usb.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xfsbl_usb.h This file contains
declarations of the descriptor structures to be used in USB boot mode. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 bvikram
02/01/17 First release </pre>

FILES:
lib/sw_apps/zynqmp_fsbl/src/xfsbl_usb.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Implementation for the custom
idling of of individual peripheral node. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/idle_hooks.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Function declarations to be used
for integrating power management within PMU firmware. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_binding.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / PM callbacks interface. Used by the
power management to send a message to the PM master and generate interrupt using
IPI. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_callbacks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Definitions of commonly used macros
and enums in PMU Power Management (PM). /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / This file contains interface of the
PM configuration object parser. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Contains the function to call for
processing a PM API call. The function (PmProcessRequest) is called from
interrupt handler stubs, implemented in pm_binding files. The request is further
processed according to the master that initiated request and API call's payload
read from master's IPI buffer. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_core.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / DDR slave definition Note: DDR does
not have a structure derived from PmSlave, currently derived structure is not
needed. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_ddr.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Definitions of commonly used enums
that have to match definitions that all software layer in the system use. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_defs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / GPU Pixel Processors slaves data
structures /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_gpp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / This file contains PM master
related data structures and functions for accessing them. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_master.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Pm Node related structures and
definitions /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_node.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Implementation of individual node
idle function and inclusion of driver header depending on the availability of
the IP in the design /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_node_idle.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Implementation of individual node
reset mechanism within power management. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_node_reset.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Implementation of notifications and
event handling within power management. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_notifier.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Contains: - PLL slave
implementation - Functions for saving and restoring PLLs' context Note: PMU does
not control states of PLLs. When none of FPD PLLs is used and FPD is going to be
powered down, PMU saves context of PLLs in FPD and asserts their reset. After
powering up FPD, PMU restores the state of PLL based on saved context. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_pll.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Power nodes (power islands and
power domains) related structures and functions /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_power.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Contains all functions, datas and
definitions needed for managing processor's states. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_proc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / PM requirements are data structures
allocated for each valid master/slave pair, used for tracking master's requests
for slave's capabilities/states. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_requirement.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Implementation of reset
configuration mechanism within power management. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_reset.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / All functions, data and definitions
needed for managing PM slaves' states. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_slave.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / SRAM memories slaves definitions
and data structures /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_sram.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / Contains system-level PM functions
/

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_system.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / USB slaves data structures /

FILES:
lib/sw_apps/zynqmp_pmufw/src/pm_usb.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xpfw_debug.h This file contains
the debug verbose information for PMUFW print functionality <pre> MODIFICATION
HISTORY: Ver Who Date Changes ---- ---- -------- </pre> @note /

FILES:
lib/sw_apps/zynqmp_pmufw/src/xpfw_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / PMU_ROM SERVICE EXTENSION IDCODES
All Services implemented in the ROM can be extended or overridden by firmware
loaded into the PMU_RAM. Including the IRQ routing infrastructure. Aside from
the PMU_ROM Service Functions, other extendable/overridable `hooks` are provided
to the firmware. These PMU_ROM Service Hooks are included in the Extension Table
but also have their IDCODES highlighted below. Before calling the default
implementation of these services, ROM checks the index indicated below in the
Service Extension Table for a function address. If a function pointer is found,
ROM will call that function /instead/ of the default ROM function. However, as
an argument to the FW function, is a callback to the default ROM function, thus
allowing the overriding FW to implmentent wrapping logic around existing ROM
behavior. @note: These Identifiers are also used to identify the service mode
error. /

FILES:
lib/sw_apps/zynqmp_pmufw/src/xpfw_rom_interface.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a hk/sg 10/17/13 First release 1.00 srm 02/16/18
Updated to pick up latest freertos port 10.0 4.1 hk 11/21/18 Add additional LFN
options 4.2 aru 07/10/19 Fix coverity warnings

FILES:
lib/sw_services/xilffs/data/xilffs.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- ------- 1.00a hk/sg 10/17/13 First release 2.0 hk 12/13/13
Modified to use new TCL API's 4.1 hk 11/21/18 Use additional LFN options FFS_drc
- check system configuration and make sure all components to run ISF are
available.

FILES:
lib/sw_services/xilffs/data/xilffs.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilffs_polled_example.c @note
This example uses file system with SD to write to and read from an SD card using
ADMA2 in polled mode. To test this example File System should not be in Read
Only mode. To test this example USE_MKFS option should be true. This example was
tested using SD2.0 card and eMMC (using eMMC to SD adaptor). To test with
different logical drives, drive number should be mentioned in both FileName and
Path variables. By default, it will take drive 0 if drive number is not
mentioned in the FileName variable. For example, to test logical drive 1
FileName "1:/<file_name>" and Path "1:/" Similarly to test logical drive N,
FileName "N:/<file_name>" and Path "N:/" None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- --- -------- 1.00a hk 10/17/13 First release 2.2 hk
07/28/14 Make changes to enable use of data cache. 2.5 sk 07/15/15 Used File
size as 8KB to test on emulation platform. 2.9 sk 06/09/16 Added support for
mkfs. 3.10 mn 08/18/18 Change file size to 8MB from 8KB for ZynqMP platform
</pre> Include Files /

FILES:
lib/sw_services/xilffs/examples/xilffs_polled_example.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

-----------------------------------------------------------------------/ Low
level disk I/O module skeleton for FatFs (C)ChaN, 2016 /
-----------------------------------------------------------------------/ @file
diskio.c This file is the glue layer between file system and driver. Description
related to SD driver: Process to use file system with SD Select xilffs in SDK
when creating a BSP In SDK, set "fs_interface" to 1 to select SD interface. This
glue layer can currently be used only with one SD controller enabled. In order
to use eMMC, in SDK set "Enable MMC" to 1. If not, SD support is enabled by
default. Description: This glue layer initializes the host controller and SD
card in disk_initialize. If SD card supports it, 4-bit mode and high speed mode
will be enabled. The default block size is 512 bytes. disk_read and disk_write
functions are used to read and write files using ADMA2 in polled mode. The file
system can be used to read from and write to an SD card that is already
formatted as FATFS. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00a hk 10/17/13 First release 2.0 hk 02/12/14 Corrected status check
in disk initialize. CR 772072. 2.1 hk 04/16/14 Move check for ExtCSD high speed
bit set inside if condition for high speed support. Include xil_types.h
irrespective of xsdps.h. CR 797086. 2.2 hk 07/28/14 Make changes to enable use
of data cache. 3.0 sk 12/04/14 Added support for micro SD without WP/CD. CR
810655. Make changes for prototypes of disk_read and disk_write according to
latest version. 12/15/14 Modified the code according to MISRAC 2012 Compliant.
Updated the FatFs to R0.10b Removed alignment for local buffers as
CacheInvalidate will take care of it. sg 03/03/15 Added card detection check
logic 04/28/15 Card detection only in case of card detection signal 3.1 sk
06/04/15 Added support for SD1. 3.2 sk 11/24/15 Considered the slot type before
checking the CD/WP pins. 3.3 sk 04/01/15 Added one second delay for checking CD
pin. 3.4 sk 06/09/16 Added support for mkfs. 3.8 mj 07/31/17 Added support for
RAM based FATfs. mn 12/04/17 Resolve errors in XilFFS for ARMCC compiler 3.9 mn
04/18/18 Resolve build warnings for xilffs library mn 07/06/18 Fix Cppcheck and
Doxygen warnings </pre> @note

FILES:
lib/sw_services/xilffs/src/diskio.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

----------------------------------------------------------------------------/
FatFs - Generic FAT Filesystem Module R0.13b /
-----------------------------------------------------------------------------/
Copyright (C) 2018, ChaN, all right reserved. FatFs module is an open source
software. Redistribution and use of FatFs in source and binary forms, with or
without modification, are permitted provided that the following condition is
met: 1. Redistributions of source code must retain the above copyright notice,
this condition and the following disclaimer. This software is provided by the
copyright holder and contributors "AS IS" and any warranties related to this
software are DISCLAIMED. The copyright owner or contributors be NOT LIABLE for
any damages caused by use of this software.
----------------------------------------------------------------------------/
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 3.9 mn 04/18/18
Resolve build warnings for xilffs library 4.2 aru 07/10/19 Fix Coverity warnings

FILES:
lib/sw_services/xilffs/src/ff.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

------------------------------------------------------------------------/ Sample
Code of OS Dependent Functions for FatFs / (C)ChaN, 2017 /
------------------------------------------------------------------------/

FILES:
lib/sw_services/xilffs/src/ffsystem.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

------------------------------------------------------------------------/
Unicode handling functions for FatFs R0.13b /
------------------------------------------------------------------------/ This
module will occupy a huge memory in the .const section when the / FatFs is
configured for LFN with DBCS. If the system has any Unicode / utilitiy for the
code conversion, this module should be modified to use / that function to avoid
silly memory consumption. /
-------------------------------------------------------------------------/
Copyright (C) 2018, ChaN, all right reserved. FatFs module is an open source
software. Redistribution and use of FatFs in source and binary forms, with or
without modification, are permitted provided that the following condition is
met: 1. Redistributions of source code must retain the above copyright notice,
this condition and the following disclaimer. This software is provided by the
copyright holder and contributors "AS IS" and any warranties related to this
software are DISCLAIMED. The copyright owner or contributors be NOT LIABLE for
any damages caused by use of this software.

FILES:
lib/sw_services/xilffs/src/ffunicode.c
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

-----------------------------------------------------------------------/ Low
level disk interface module include file (C)ChaN, 2014 /
-----------------------------------------------------------------------/

FILES:
lib/sw_services/xilffs/src/include/diskio.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

----------------------------------------------------------------------------/
FatFs - Generic FAT Filesystem module R0.13b /
-----------------------------------------------------------------------------/
Copyright (C) 2018, ChaN, all right reserved. FatFs module is an open source
software. Redistribution and use of FatFs in source and binary forms, with or
without modification, are permitted provided that the following condition is
met: 1. Redistributions of source code must retain the above copyright notice,
this condition and the following disclaimer. This software is provided by the
copyright holder and contributors "AS IS" and any warranties related to this
software are DISCLAIMED. The copyright owner or contributors be NOT LIABLE for
any damages caused by use of this software.
----------------------------------------------------------------------------/

FILES:
lib/sw_services/xilffs/src/include/ff.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @BEGIN_CHANGELOG EDK_LS3 Added
platfrom_flash parameter to select whether a Xilinx Platform Flash XL device is
present in the system and is to be used. @END_CHANGELOG Modification History Ver
Who Date Changes ----- ---- -------- 3.00a sdm 03/03/11 Removed static flash
parameters in the library 3.00a sdm 03/23/11 Added new parameters to enable
support for flash families 4.4 ms 08/03/17 Added tags and modified comment lines
style for doxygen. 4.4 srm 02/16/18 Updated to pick up latest freertos port 10.0
4.6 akm 01/22/19 Fixed compilation error of application with xilflash
library(CR1018603)

FILES:
lib/sw_services/xilflash/data/xilflash.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @BEGIN_CHANGELOG EDK_LS3 Added
XPAR_XFL_PLATFORM_FLASH to be generated in the xparameters.h. If the user
selects Platform Flash XL device to be used then parameter will be set to 1.
@END_CHANGELOG Modification History Ver Who Date Changes ----- ---- --------
2.03a sdm 09/24/10 updated to use Tcl commands instead of unix commands 3.00a
sdm 03/03/11 Removed static flash parameters in the library 3.00a sdm 03/23/11
Added new parameters to enable support for flash families Flash_drc

FILES:
lib/sw_services/xilflash/data/xilflash.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilflash_devicecontrol_example.c This file contains a design example using the
Generic Flash Library. This example displays the Flash device geometry and
properties. The geometry and properties are fetched using Device Control API.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.01a mta 10/09/07 First release 2.00a ktn 12/04/09 Updated to use the HAL
processor APIs/macros 3.00a sdm 03/03/11 Updated to pass BaseAddress and Flash
Width to _Initialize API, as required by the new version of the library 4.7 akm
07/23/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilflash/examples/xilflash_devicecontrol_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilflash_platform_flash_example.c This file contains a design example using the
Flash Library with the Xilinx Platform Flash XL device. This example tests
Unlock, Erase, Read and Write features. The Page is unlocked, erased and data is
written to the page. The data is read back and compared with the data written
for correctness. This example also shows usage of XFlash_DeviceControl to set
the Platform Flash XL device in the Async/Sync Mode. @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a ksu
06/16/09 First release 2.00a ktn 12/04/09 Updated to use the HAL processor
APIs/macros 3.00a sdm 03/03/11 Updated to pass BaseAddress and Flash Width to
_Initialize API, as required by the new version of the library 4.7 akm 07/23/19
Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilflash/examples/xilflash_platform_flash_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_protection_example.c
This file contains a design example using the Generic Flash Library. This
example tests the Lock and UnLock features of the Flash Device. A block is
Locked and an attempt is made to erase a Page in that block. This should return
an error. The block is then unlocked and an attempt is made to erase a page in
that block which should succeed. A page of data is written, read back and
compared with the data written for correctness. @note This example has been
tested with an Intel CFI compliant Flash device. This example has not been
tested with an AMD CFI compliant Flash device. The AMD CFI compliant Flash
devices require the user to apply a 12V DC voltage on the RP pin while
performing the Lock and Unlock operations. Change the value of XFL_TO_ASYNCMODE
to 1, inorder to operate the Micron Flash in async mode,if it was set to sync
mode. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a
mta 10/09/07 First release 1.01a sdm 02/24/09 Updated the notes with information
about using the example with AMD CFI compliant Flash devices 2.00a ktn 12/04/09
Updated to use the HAL processor APIs/macros 3.00a sdm 03/03/11 Updated to pass
BaseAddress and Flash Width to _Initialize API, as required by the new version
of the library 4.2 nsk 01/29/16 Added Support to change Flash to Async Mode, if
it was set to sync mode. Modified FLASH_BASE_ADDRESS to canonical name. 4.7 akm
07/23/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilflash/examples/xilflash_protection_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_readwrite_example.c
This file contains a design example using the Flash Library. This example tests
the Erase, Read and Write features. The Page is erased and data is written to
the page. The data is read back and compared with the data written for
correctness. @note The Erase operation on a CFI compliant Flash device will
result in an error if the block is locked. This example performs an Unlock
operation before Erase operation only on the Intel CFI compliant Flash device.
The AMD CFI compliant Flash devices require the user to apply a 12V DC voltage
on the RP pin while performing the Lock and Unlock operations. This example will
not work with the AMD compliant Flash devices if the block is locked and the
user doesn't perform an Unlock operation. Change the value of XFL_TO_ASYNCMODE
to 1, inorder to operate the Micron Flash in async mode,if it was set to sync
mode. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a
mta 10/09/07 First release 1.01a ksu 04/10/08 Added support for AMD CFI
Interface 1.01a sdm 02/24/09 a) Added code to perform an Unlock operation before
the Erase operation for Intel CFI compliant Flash devices b) Updated the notes
with information about using the example with AMD CFI compliant Flash devices
2.00a ktn 12/04/09 Updated to use the HAL processor APIs/macros 3.00a sdm
03/03/11 Updated to pass BaseAddress and Flash Width to _Initialize API, as
required by the new version of the library 4.2 nsk 01/07/16 Added Support to
change Flash to Async Mode, if it was set to sync mode. Modified
FLASH_BASE_ADDRESS to canonical name. 4.2 nsk 01/27/16 Added check to unlock the
Micron G18 Flash. 4.7 akm 07/23/19 Initialized Status variable to XST_FAILURE.
</pre> Include Files /

FILES:
lib/sw_services/xilflash/examples/xilflash_readwrite_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash.c This file contains
the library functions to Initialize, Read, Write, Erase, Lock and Unlock the
Parallel Flash Device. The family specific functionalities are implemented in
DeviceControl API. Refer xilflash.h for detailed description. @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm
10/20/07 First release 1.00a mta 10/25/07 Updated to flash library 1.01a ksu
04/10/08 Added support for AMD CFI Interface 1.02a ksu 06/16/09 Added support
for multiple banks in Intel flash. Added support for Xilinx Platform Flash XL.
If the user selects to use the Xilinx Platform Flash XL then it is set to Async
mode during the initialization. If the user wants to use it in Sync mode then it
can be done using the XFlash_DeviceControl API. 2.00a ktn 12/04/09 Updated to
use the HAL processor APIs/macros. 3.00a sdm 03/03/11 Removed static parameters
in mld and updated code to determine these parameters from the CFI data. 3.01a
srt 03/02/12 Added support for Micron G18 Flash device to fix CRs 648372,
648282. 3.02a srt 05/30/12 Changed Implementation for Micron G18 Flash, which
fixes the CR 662317. CR 662317 Description - Xilinx Platform Flash on ML605
fails to work. 4.4 ms 08/03/17 Added tags and modified comment lines style for
doxygen. </pre> Include Files /

FILES:
lib/sw_services/xilflash/src/xilflash.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_amd.c This file
implements the AMD CFI Version of the XFlash Library. @note - Special
consideration has to be given to varying data bus widths. To boost performance,
multiple devices in parallel on the data bus are accessed in parallel. Therefore
to reduce complexity and increase performance, many local primitive functions
are duplicated with the only difference being the width of writes to the
devices. <br><br> Even with the performance boosting optimizations, the overhead
associated is rather high due to the general purpose nature of its design.
<br><br> Flash block erasing is a time consuming operation with nearly all
latency occurring due to the devices' themselves. It takes on the order of 1
second to erase each block. <br><br> Writes by comparison are much quicker so
library overhead becomes an issue. The write algorithm has been optimized for
bulk data programming and should provide relatively better performance. - This
library and the underlying AMD flash memory does not allow re programming while
code is executing from the same memory. - If hardware is flakey or fails, then
this library could hang a thread of execution. - This library is only tested on
M29DW323DT device in 8 bit and 16 bit mode of operation. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a ksu 04/10/08 First
release. 1.02a ksu 06/16/09 Added Reset Bank function Added bank(s) reset
operation at the top of the read function Fixed memory corruption issue in 16
bit read operation 2.01a ktn 03/31/10 Updated to support uniform sector WP
modes. 2.02a sdm 07/07/10 Updated XFlashAmd_Initialize() to NOT change the erase
region information of a top boot device, when the number of erase regions is not
more than 1. 4.1 nsk 06/06/12 Updated Spansion WriteBuffer programming. (CR
781697). 4.7 akm 07/10/19 Updated XFlashAmd_Write() to use adjusted base address
in write operation(CR-1029074). 4.7 akm 07/23/19 Initialized Status variable to
XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilflash/src/xilflash_amd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_cfi.c The file
implements the functions for retrieval and translation of CFI data from a
compliant flash device. CFI contains data that defines part geometry,
write/erase timing, and programming data. Data is retrieved using macros defined
in this xflash_cfi.h file. The macros simplify data extraction because they have
been written to take into account the layout of parts on the data bus. To the
library, CFI data appears as if it were always being read from a single 8-bit
part (XFL_LAYOUT_X8_X8_X1) Otherwise, the retrieval code would have to contend
with all the formats illustrated below. The illustration shows how the first
three bytes of the CFI query data "QRY" appear in flash memory space for various
part layouts. <pre> Byte Offset (Big-Endian) 0123456789ABCDEF
XFL_LAYOUT_X16_X16_X1 Q R Y XFL_LAYOUT_X16_X16_X2 Q Q R R Y Y </pre> Where the
holes between Q, R, and Y are NULL (all bits 0) @note This code is intended to
be RTOS and processor independent. It works with physical addresses only. Any
needs for dynamic memory management, threads, mutual exclusion, virtual memory,
or cache control management must be satisfied by the layer above this library.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm
10/25/07 First release 1.00a mta 10/25/07 Updated to flash library 1.01a ksu
04/10/08 Added support for AMD CFI Interface 1.02a ksu 08/06/09 Added code to
read the platform flash bank information 2.00a ktn 12/04/09 Updated to use the
HAL processor APIs/macros 2.02a sdm 06/30/10 Updated to support AXI EMC with
Little Endian Processor 3.00a sdm 03/03/11 Removed static parameters in mld and
updated code to determine these parameters from the CFI data. 3.01a srt 03/02/12
Added support for Micron G18 Flash device to fix CRs 648372, 648282. Added
DATA_SYNC to fix the CR 644750. 3.02a srt 05/30/12 Changed Implementation for
Micron G18 Flash, which fixes the CR 662317. CR 662317 Description - Xilinx
Platform Flash on ML605 fails to work. 3.04a srt 02/18/13 Fixed CR 700553. 4.5
tjs 08/13/18 Fixed compilation errors for ARMCC (CR1008306) 4.7 akm 07/23/19
Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilflash/src/xilflash_cfi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_intel.c This file
implements the Intel CFI Version of the XFlash Library. @note - Special
consideration has to be given to varying data bus widths. To boost performance,
multiple devices in parallel on the data bus are accessed in parallel. Therefore
to reduce complexity and increase performance, many local primitive functions
are duplicated with the only difference being the width of writes to the
devices. <br><br> Even with the performance boosting optimizations, the overhead
associated is rather high due to the general purpose nature of its design.
<br><br> Flash block erasing is a time consuming operation with nearly all
latency occurring due to the devices' themselves. It takes on the order of 1
second to erase each block. <br><br> Writes by comparison are much quicker so
library overhead becomes an issue. The write algorithm has been optimized for
bulk data programming and should provide relatively better performance. - The
code/comments refers to WSM frequently. This stands for Write State Machine. WSM
is the internal programming engine of the devices. - This library and the
underlying Intel flash memory does not allow re programming while code is
executing from the same memory. - If hardware is flakey or fails, then this
library could hang a thread of execution. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a rmm 10/25/07 First release 1.00a mta
10/25/07 Updated to flash library 1.01a ksu 04/10/08 Added support for AMD CFI
Interface 1.02a ksu 06/16/09 Added support for multiple banks in Intel flash
Added Reset Bank function Added support for 0xF0 reset command Added support for
Xilinx Platform Flash XL. Added XFL_DEVCTL_SET_CONFIG_REG IOCTL to write to the
Configuration Register of the Xilinx Platform Flash XL which can be used to set
the Flash in Sync/Async mode. The Xilinx Platform Flash XL is set to Async mode
during the initialization of the library. Added bank(s) reset function at the
top of the read function. Updated Lock and Unlock operations for multiple
blocks. 1.03a ksu 10/07/09 Added support for large buffer size flash (CR535564)
3.01a srt 03/02/12 Added support for Micron G18 Flash device to fix CRs 648372,
648282. Modified XFlashIntel_Reset function to reset all the partitions. 3.02a
srt 05/30/12 Changed Implementation for Micron G18 Flash, which fixes the CR
662317. CR 662317 Description - Xilinx Platform Flash on ML605 fails to work.
3.03a srt 11/04/12 Fixed CR 679937 Description: Non-word aligned data write to
flash fails with AXI interface. 4.1 nsk 08/06/15 Fixed CR 835008. 4.7 akm
07/23/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilflash/src/xilflash_intel.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash.h @addtogroup
xilflash_apis Library-APIs @{ @cond xilflash_internal @{ This module implements
the functionality for flash memory devices that conform to the "Common Flash
Interface" (CFI) standard. CFI allows a single flash library to be used for an
entire family of parts. This is not a library for a specific device, but for a
set of command read/write/erase algorithms. CFI allows us to determine which
algorithm to utilize at runtime. <b>Library Initialization</b> The function call
XFlash_Initialize() should be called by the application before any other
function in the library. The initialization function checks for the device
family and initializes the XFlash instance with the family specific data. The VT
table (Contains the function pointers to family specific API's) is setup and
family specific initialization routine is called. <b>Device Geometry</b> The
Device geometry varies for different flash device families. The following list
describes geometry of different flash device families: <b> Intel Flash Device
Geometry </b> Flash memory space is segmented into areas called blocks. The size
of each block is based on a power of 2. A region is defined as a contiguous set
of blocks of the same size. Some parts have several regions while others have
one. The arrangement of blocks and regions is referred to by this module as the
part's geometry. Some Intel flash supports multiple banks on the same device.
This library supports single and multiple bank flash devices. <b> AMD Flash
Device Geometry </b> Flash memory space is segmented into areas called banks and
further in to regions and blocks. The size of each block is based on a power of
2. A region is defined as a contiguous set of blocks of the same size. Some
parts have several regions while others have one. A bank is defined as a
contiguous set of blocks. The bank may contain blocks of different size. The
arrangement of blocks, regions and banks is referred to by this module as the
part's geometry. The cells within the part can be programmed from a logic 1 to a
logic 0 and not the other way around. To change a cell back to a logic 1, the
entire block containing that cell must be erased. When a block is erased all
bytes contain the value 0xFF. The number of times a block can be erased is
finite. Eventually the block will wear out and will no longer be capable of
erasure. As of this writing, the typical flash block can be erased 100,000 or
more times. <b>Write Operation</b> The write call can be used to write a minimum
of zero bytes and a maximum entire flash. If the Offset Address specified to
write is out of flash or if the number of bytes specified from the Offset
address exceed flash boundaries an error is reported back to the user. The write
is blocking in nature in that the control is returned back to user only after
the write operation is completed successfully or an error is reported. <b>Read
Operation</b> The read call can be used to read a minimum of zero bytes and
maximum of entire flash. If the Offset Address specified to write is out of
flash boundary an error is reported back to the user. The read function reads
memory locations beyond Flash boundary. Care should be taken by the user to make
sure that the Number of Bytes + Offset address is within the Flash address
boundaries. The write is blocking in nature in that the control is returned back
to user only after the read operation is completed successfully or an error is
reported. <b>Erase Operation</b> The erase operations are provided to erase a
Block in the Flash memory. The erase call is blocking in nature in that the
control is returned back to user only after the erase operation is completed
successfully or an error is reported. <b>Sector Protection</b> The Flash Device
is divided into Blocks. Each Block can be protected individually from
unwarranted writing/erasing. The Block locking can be achieved using
XFlash_Lock() lock. All the memory locations from the Offset address specified
will be locked. The block can be unlocked using XFlash_UnLock() call. All the
Blocks which are previously locked will be unlocked. The Lock and Unlock calls
are blocking in nature in that the control is returned back to user only after
the operation is completed successfully or an error is reported. The AMD flash
device requires high voltage on Reset pin to perform lock and unlock operation.
User must provide this high voltage (As defined in datasheet) to reset pin
before calling lock and unlock API for AMD flash devices. Lock and Unlock
features are not tested for AMD flash device. <b>Device Control</b>
Functionalities specific to a Flash Device Family are implemented as Device
Control. The following are the Intel specific device control: - Retrieve the
last error data. - Get Device geometry. - Get Device properties. - Set RYBY pin
mode. - Set the Configuration register (Platform Flash only). The following are
the AMD specific device control: - Get Device geometry. - Get Device properties.
- Erase Resume. - Erase Suspend. - Enter Extended Mode. - Exit Extended Mode. -
Get Protection Status of Block Group. - Erase Chip. @note <b>This library needs
to know the type of EMC core (AXI or XPS) used to access the cfi flash, to map
the correct APIs. This library should be used with the emc driver, v3_01_a and
above, so that this information can be automatically obtained from the emc
driver.</b> This library is intended to be RTOS and processor independent. It
works with physical addresses only. Any needs for dynamic memory management,
threads, mutual exclusion, virtual memory, cache control, or HW write protection
management must be satisfied by the layer above this library. <br><br> All
writes to flash occur in units of bus-width bytes. If more than one part exists
on the data bus, then the parts are written in parallel. Reads from flash are
performed in any width up to the width of the data bus. It is assumed that the
flash bus controller or local bus supports these types of accesses. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm
10/25/07 First release 1.00a mta 10/25/07 Updated to flash library 1.01a ksu
04/10/08 Added support for AMD CFI Interface 1.02a ksu 06/16/09 Added support
for multiple banks in Intel flash Removed unused defines (XFL_MAX_NUM_BANKS,
XFL_BANK1, XFL_BANK2) Added IOCTL to set configuration register of platform
flash 1.03a ksu 10/07/09 Added support for large buffer size flash (CR535564)
2.00a ktn 12/04/09 Updated to use the HAL processor APIs/macros 2.01a ktn
03/31/10 Updated the AMD code to support uniform sector WP modes 2.02a sdm
06/30/10 Updated to support AXI EMC with Little Endian Processor 2.02a sdm
07/07/10 Updated XFlashAmd_Initialize() to NOT change the erase region
information of a top boot device, when the number of erase regions is not more
than 1. 3.00a sdm 03/03/11 Removed static parameters in mld and updated code to
determine these parameters from the CFI data. 3.00a sdm 03/23/11 Added two new
parameters in mld for flash families. Users can enable support for either of the
flash devices or both of them. 3.01a srt 03/02/12 Added support for Micron G18
Flash device to fix CRs 648372, 648282. Modified XFlashIntel_Reset function to
reset all the partitions. Added DATA_SYNC to fix the CR 644750. 3.02a srt
05/30/12 Changed Implementation for Micron G18 Flash, which fixes the CR 662317.
CR 662317 Description - Xilinx Platform Flash on ML605 fails to work. 3.03a srt
11/04/12 Increased AMD maximum erase regions (CR 668730) Fixed CR 679937
Description: Non-word aligned data write to flash fails with AXI interface.
3.04a srt 02/18/13 Fixed CR 700553. 4.1 nsk 06/06/12 Updated WriteBuffer
programming for spansion in xilflash_amd.c and added new definitions as per AMD
Spec in xilflash_amd.h (CR 781697). 4.1 nsk 08/06/15 Fixed CR 835008 Modified
xilflash_intel.c. 4.2 nsk 01/07/15 Add Support to change Flash from Sync to
Async Mode. Updated xilflash_readwrite_example.c file. Modified
FLASH_BASE_ADDRESS in xilflash_readwrite _example.c to canonical name (CR
808007) 4.3 ms 01/17/17 Fixed compilation warnings. 4.4 ms 08/03/17 Added
doxygen tags. 4.5 tjs 08/13/18 Fixed compilation errors for ARMCC (CR1008306)
4.6 akm 01/22/19 Fixed compilation errors (CR1018603) 4.7 akm 07/10/19 Updated
XFlashAmd_Write() to use adjusted base address in write operation(CR-1029074).
4.7 akm 07/23/19 Initialized Status variable to XST_FAILURE. </pre>

FILES:
lib/sw_services/xilflash/src/include/xilflash.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_amd.h This file
consists definitions, Macros and structures specific to the AMD flash devices.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a ksu
04/10/08 First Release. 2.01a ktn 03/31/10 Updated the AMD code to support
uniform sector WP modes. Added the new definitions XFL_AMD_TOP_WP_UNIFORM and
XFL_AMD_BOTTOM_WP_UNIFORM. 4.1 nsk 06/06/12 Added New definitions as per AMD
spec. (CR 781697). 4.7 akm 07/10/19 Updated XFlashAmd_Write() to use adjusted
base address in write operation(CR-1029074). </pre>

FILES:
lib/sw_services/xilflash/src/include/xilflash_amd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_cfi.h This file
contains methods used to extract and interpret Common Flash Interface(CFI) from
a flash memory part that supports the CFI query command. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm 10/25/07 First
release 1.00a mta 10/25/07 Updated to flash library 1.01a ksu 04/10/08 Added
support for AMD CFI Interface 2.00a ktn 12/04/09 Updated to use the HAL
processor APIs/macros </pre>

FILES:
lib/sw_services/xilflash/src/include/xilflash_cfi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_intel.h This file
consists definitions, Macros and structures specific to the Intel flash devices.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm
10/25/07 First release 1.00a mta 10/25/07 Updated to flash library 1.01a ksu
04/10/08 Added support for AMD CFI Interface 1.02a ksu 06/16/09 Added support
for multiple banks in Intel flash. Added Reset Bank function. Added support for
0xF0 reset command. Added XFL_DEVCTL_SET_CONFIG_REG IOCTL to write to the
Configuration Register of the Xilinx Platform Flash XL which can be used to set
the Flash in Sync/Async mode. The Xilinx Platform Flash XL is set to Async mode
during the initialization of the library. Added bank(s) reset function at the
top of the read function. Updated Lock and Unlock operations for multiple
blocks. 3.01a srt 03/02/12 Added support for Micron G18 Flash device to fix CRs
648372, 648282. 3.02a srt 05/30/12 Changed Implementation for Micron G18 Flash,
which fixes the CR 662317. CR 662317 Description - Xilinx Platform Flash on
ML605 fails to work. </pre>

FILES:
lib/sw_services/xilflash/src/include/xilflash_intel.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilflash_properties.h This file
contains various data common to flash devices most of which can be derived from
the CFI query. @note There is no implementation file with this component. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rmm
10/25/07 First release 1.00a mta 10/25/07 Updated to flash library 1.01a ksu
04/10/08 Added support for AMD CFI Interface 1.02a ksu 06/16/09 Changed size of
DeviceID in XFlashPartID structure 2.00a ktn 12/04/09 Updated to use the HAL
processor APIs/macros 3.01a srt 03/02/12 Added support for Micron G18 Flash
device to fix CRs 648372, 648282. 3.02a srt 05/30/12 Changed Implementation for
Micron G18 Flash, which fixes the CR 662317. CR 662317 Description - Xilinx
Platform Flash on ML605 fails to work. </pre>

FILES:
lib/sw_services/xilflash/src/include/xilflash_properties.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 Nava 08/06/16 First release 1.1 Nava 16/11/16
Added PL power-up sequence. 2.0 Nava 10/1/17 Added Encrypted bitstream loading
support. 2.0 Nava 16/02/17 Added Authenticated bitstream loading support. 2.1
Nava 06/05/17 Correct the check logic issues in XFpga_PL_BitStream_Load() to
avoid the unwanted blocking conditions. 3.0 Nava 12/05/17 Added PL configuration
registers readback support. 4.0 Nava 08/02/18 Added Authenticated and Encypted
Bitstream loading support. srm 02/26/18 Updated to pick up latest freertos port
10.0 4.1 Nava 27/03/18 For Secure Bitstream loading to avoid the Security
violations Need to Re-validate the User Crypto flags with the Image Crypto
operation by using the internal memory.To Fix this added a new API
XFpga_ReValidateCryptoFlags(). 4.1 Nava 16/04/18 Added partial bitstream loading
support. 4.2 Nava 30/05/18 Refactor the xilfpga library to support different PL
programming Interfaces. 4.2 Nava 15/09/18 Fixed global function call-backs
issue. 5.0 Nava 11/05/18 Added full bitstream loading support for versal
Platform. 5.0 Nava 29/03/19 Removed vesal platform related changes.As per the
new design, the Bitstream loading for versal platform is done by PLM based on
the CDO's data exists in the PDI images. So there is no need of xilfpga API's
for versal platform to configure the PL. 5.1 Nava 27/06/19 Updated documentation
for readback API's.

FILES:
lib/sw_services/xilfpga/data/xilfpga.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 Nava 08/06/16 First release 1.1 Nava 16/11/16
Added PL power-up sequence. 2.0 Nava 10/1/17 Added Encrypted bitstream loading
support. 2.0 Nava 16/02/17 Added Authenticated bitstream loading support. 2.1
Nava 06/05/17 Correct the check logic issues in XFpga_PL_BitStream_Load() to
avoid the unwanted blocking conditions. 3.0 Nava 12/05/17 Added PL configuration
registers readback support. 4.0 Nava 08/02/18 Added Authenticated and Encypted
Bitstream loading support. 4.1 Nava 27/03/18 For Secure Bitstream loading to
avoid the Security violations Need to Re-validate the User Crypto flags with the
Image Crypto operation by using the internal memory.To Fix this added a new API
XFpga_ReValidateCryptoFlags(). 4.1 Nava 16/04/18 Added partial bitstream loading
support. 4.2 Nava 30/05/18 Refactor the xilfpga library to support different PL
programming Interfaces. 4.2 adk 24/07/18 Added proper error message if xilsecure
is not enabled in the bsp. 5.0 Nava 11/05/18 Added full bitstream loading
support for versal Platform. 5.0 sne 27/03/19 Fixed Misra-C violations. 5.0 Nava
29/03/19 Removed vesal platform related changes.As per the new design, the
Bitstream loading for versal platform is done by PLM based on the CDO's data
exists in the PDI images. So there is no need of xilfpga API's for versal
platform to configure the PL. fpga_drc

FILES:
lib/sw_services/xilfpga/data/xilfpga.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xfpga_load_bitstream_example.c This file contains the example using Xilfpga
library to transfer the user provided Bitstream into zynqmp pl region. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 1.0 Nava
08/06/16 First release 4.0 Nava 21/02/18 Updated the example relevant to src
code changes. 4.2 Nava 30/05/18 Refactor the xilfpga library to support
different PL programming Interfaces. 4.2 adk 23/08/18 Added bitstream size
define. 5.0 Nava 06/02/19 Updated the example to sync with 5.0 version API's 5.0
Nava 16/03/19 Typical bitstram size of zcu102 board is 26MB.So updated the
bitstream size macro value for the same. </pre> /

FILES:
lib/sw_services/xilfpga/examples/xfpga_load_bitstream_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file
xfpga_partialbitstream_load_example.c Partial reconfiguration(PR) is the ability
for a portion of an FPGA to be reprogrammed while the remainder of the system
stays unchanged. Dynamic PR allows device reconfiguration during runtime while
rest of the Device is still functioning. This file contains the example using
xilfpga library to transfer the user provided Partial Reconfiguration Bitstream
into ZynqMP PL region. Before loading this example please make sure static
Bitstream associated with the PR design has been loaded into the PL. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 4.2 adk
03/08/18 Initial Release. 4.2 adk 23/08/18 Added bitstream size define. 5.0 Nava
06/02/19 Updated the example to sync with 5.0 version API's </pre> /

FILES:
lib/sw_services/xilfpga/examples/xfpga_partialbitstream_load_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xfpga_readback_example.c This
example prints out the fpga configuration data. This example assumes that there
is a UART Device or STDIO Device in the hardware system. @note None.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ---- -------- 4.2 adk
11/07/18 First Release 4.2 Nava 16/08/18 Modified the PL data handling Logic to
support different PL programming interfaces. 5.0 Nava 06/02/19 Updated the
example to sync with 5.0 version API's rama 03/04/19 Fixed IAR compiler warning
</pre> / Include Files /

FILES:
lib/sw_services/xilfpga/examples/xfpga_readback_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xfpga_reg_readback_example.c
This example prints out the values of all the configuration registers in the
FPGA. This example assumes that there is a UART Device or STDIO Device in the
hardware system. @note None. MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ---- -------- 2.1 Nava 05/10/17 First Release 4.2 Nava 30/05/18 Refactor
the xilfpga library to support different PL programming Interfaces. 5.0 Nava
06/02/19 Updated the example to sync with 5.0 version API's rama 03/04/19 Fixed
IAR compiler warning </pre> / Include Files /

FILES:
lib/sw_services/xilfpga/examples/xfpga_reg_readback_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilfpga.c This file contains
the definitions of Bitstream loading functions. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 4.2 Nava 08/06/16 Refactor the xilfpga
library to support different PL programming Interfaces. 4.2 adk 11/07/18 Added
support for readback of PL configuration data. 4.2 Nava 16/08/18 Modified the PL
data handling Logic to support different PL programming interfaces. 4.2 Nava
15/09/18 Fixed global function call-backs issue. 5.0 Nava 11/05/18 Added full
bitstream loading support for versal Platform. 5.0 Div 21/01/19 Fixed misra-c
required standard violation for zynqmp. 5.0 Nava 06/02/19 Remove redundant API's
from the interface agnostic layer and make the existing API's generic to support
both ZynqMP and versal platforms. 5.0 Nava 26/02/19 Update the data handling
logic to avoid the code duplication 5.0 sne 27/03/19 Fixed misra-c violations.
5.0 Nava 29/03/19 Removed vesal platform related changes.As per the new design,
the Bitstream loading for versal platform is done by PLM based on the CDO's data
exists in the PDI images. So there is no need of xilfpga API's for versal
platform to configure the PL. 5.1 Nava 27/06/19 Updated documentation for
readback API's. 5.1 Nava 16/07/19 Initialize empty status (or) status success to
status failure to avoid security violations. </pre> @note / Include Files /

FILES:
lib/sw_services/xilfpga/src/xilfpga.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilfpga.h @addtogroup
xfpga_apis XilFPGA APIs @{ Xilfpga Error format: Lower level Errors + Interface
specific Errors + Xilfpga top layer Errors Lower level Errors | Interface
Specific Errors | Xilfpga top layer Errors (other libarier | (PCAP Interface) |
or drivers | | Used by xilfpga) | | 31 - 16 bits | 15 - 8 bits | 7 - 0 bits
Xilfpga Top Layer: The functionality exist in this layers is completely
Interface agnostic. It provides a unique interface to load the Bitstream across
multiple platforms.(ie; ZynqMP) Interface Specific layer: This layer is
responsible for providing the interface specific related errors. In Case of
ZynqMp, it provides the errors related to PCAP Interface. Xilfpga lower layer:
This layer is responsible for providing the Error related to the lower level
drivers used by Interface layer. @{ @cond xilfpga_internal <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 4.2 Nava 08/06/16 Refactor the
xilfpga library to support different PL programming Interfaces. 4.2 adk 11/07/18
Added support for readback of PL configuration data. 4.2 Nava 16/08/18 Modified
the PL data handling Logic to support different PL programming interfaces. 4.2
adk 28/08/18 Fixed misra-c required standard violations. 4.2 Nava 15/09/18 Fixed
global function call-backs issue. 5.0 Nava 11/05/18 Added full bitstream loading
support for versal Platform. 5.0 Div 21/01/19 Fixed misra-c required standard
violations. 5.0 Nava 06/02/19 Remove redundant API's from the interface agnostic
layer and make the existing API's generic to support both ZynqMP and versal
platforms. 5.0 Nava 26/02/19 Update the data handling logic to avoid the code
duplication 5.0 sne 27/03/19 Fixed misra-c violations. 5.0 Nava 29/03/19 Removed
vesal platform related changes.As per the new design, the Bitstream loading for
versal platform is done by PLM based on the CDO's data exists in the PDI images.
So there is no need of xilfpga API's for versal platform to configure the PL.
</pre> @note /

FILES:
lib/sw_services/xilfpga/src/xilfpga.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilfpga_pcap.c This file
contains the definitions of bitstream loading functions. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 Nava 08/06/16 Initial
release 1.1 Nava 16/11/16 Added PL power-up sequence. 2.0 Nava 10/1/17 Added
Encrypted bitstream loading support. 2.0 Nava 16/02/17 Added Authenticated
bitstream loading support. 2.1 Nava 06/05/17 Correct the check logic issues in
XFpga_PL_BitStream_Load() to avoid the unwanted blocking conditions. 3.0 Nava
12/05/17 Added PL configuration registers readback support. 4.0 Nava 08/02/18
Added Authenticated and Encypted Bitstream loading support. 4.0 Nava 02/03/18
Added the legacy bit file loading feature support from U-boot. and improve the
error handling support by returning the proper ERROR value upon error
conditions. 4.1 Nava 7/03/18 For Secure Bitstream loading to avoid the Security
violations Need to Re-validate the User Crypto flags with the Image Crypto
operation by using the internal memory.To Fix this added a new API
XFpga_ReValidateCryptoFlags(). 4.1 Nava 16/04/18 Added partial bitstream loading
support. 4.2 Nava 08/06/16 Refactor the xilfpga library to support different PL
programming Interfaces. 4.2 adk 11/07/18 Added support for readback of PL
configuration data. 4.2 Nava 22/07/18 Added XFpga_SelectEndianess() new API to
Support programming the vivado generated .bit and .bin files. 4.2 Nava 16/08/18
Modified the PL data handling Logic to support different PL programming
interfaces. 4.2 adk 23/08/18 Added support for unaligned bitstream programming.
4.2 adk 28/08/18 Fixed misra-c required standard violations. 4.2 Nava 15/09/18
Fixed global function call-backs issue. 5.0 Nava 10/01/19 Improve the PS-PL
resets handling. 5.0 Nava 10/01/19 Improve the Image validation handling logic
for bootgen created Bitstream Images. 5.0 Div 21/01/19 Fixed misra-c required
standard violations. 5.0 Nava 06/02/19 Remove redundant API's from the interface
agnostic layer and make the existing API's generic to support both ZynqMP and
versal platforms. 5.0 Nava 26/02/19 Fix for power-up PL issue with pmufw. 5.0
Nava 26/02/19 Update the data handling logic to avoid the code duplication 5.0
Nava 28/02/19 Handling all the 4 PS-PL resets irrespective of the design
configuration. 5.0 vns 12/03/19 Modified secure stream switch related functions.
5.0 Nava 19/03/19 In the current implementation, the SecureIv variable is
sharing between xilfpga and Xilsecure libraries. To avoid data sharing conflicts
removed SecureIV shared variable dependency. 5.0 Nava 21/03/19 Added Address
alignment check. As CSUDMA expects word aligned address. In case user passes an
unaligned address return error. 5.0 sne 27/03/19 Fixed misra-c violations. 5.0
Nava 23/04/19 Optimize the API's logic to avoid code duplication. 5.1 Nava
27/06/19 Adds support to clear out the SHA3 engine. 5.1 Nava 05/07/19 Zeroize
the Secure data to avoid security violations. 5.1 Nava 16/07/19 Begin all
functions return status with failure and return to success only on successful
completion of the operation of the functions. 5.1 Nava 16/07/19 Improve error
handling in the bitstream validation path. </pre> @note / Include Files /

FILES:
lib/sw_services/xilfpga/src/interface/zynqmp/xilfpga_pcap.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilfpga_pcap.h @addtogroup
xfpga_apis XilFPGA APIs @{ The XILFPGA library provides the interface to the
application to configure the programmable logic (PL) though the PS. - Supported
Features: - Full Bitstream loading. - Partial Bitstream loading. - Encrypted
Bitstream loading. - Authenticated Bitstream loading. - Authenticated and
Encrypted Bitstream loading. - Partial Bitstream loading. Xilfpga_PL library
Interface modules {xilfpgapllib} Xilfpga_PL library uses the below major
components to configure the PL through PS. - CSU DMA driver is used to transfer
the actual Bit stream file for the PS to PL after PCAP initialization -
Xilsecure_library provides APIs to access secure hardware on the Zynq&reg
UltraScale+&tm MPSoC devices. This library includes: - SHA-3 engine hash
functions - AES for symmetric key encryption - RSA for authentication These
algorithms are needed to support to load the Encrypted and Authenticated
Bitstreams into PL. @note XilFPGA library is capable of loading only .bin format
files into PL. The library does not support other file formats. Initialization &
Writing Bitstream {xilinit} Use the u32 XFpga_PL_BitSream_Load(); function to
initialize the driver and load the Bitstream. @{ @cond xilfpga_internal <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 Nava 08/06/16
Initial release 1.1 Nava 16/11/16 Added PL power-up sequence. 2.0 Nava 10/1/17
Added Encrypted bitstream loading support. 2.0 Nava 16/02/17 Added Authenticated
bitstream loading support. 2.1 Nava 06/05/17 Correct the check logic issues in
XFpga_PL_BitStream_Load() to avoid the unwanted blocking conditions. 3.0 Nava
12/05/17 Added PL configuration registers readback support. 4.0 Nava 08/02/18
Added Authenticated and Encypted Bitstream loading support. 4.0 Nava 02/03/18
Added the legacy bit file loading feature support from U-boot.and improve the
error handling support by returning the proper ERROR value upon error
conditions. 4.1 Nava 27/03/18 For Secure Bitstream loading to avoid the Security
violations Need to Re-validate the User Crypto flags with the Image Crypto
operation by using the internal memory.To Fix this added a new API
XFpga_ReValidateCryptoFlags(). 4.1 Nava 16/04/18 Added partial bitstream loading
support. 4.2 Nava 08/06/16 Refactor the xilfpga library to support different PL
programming Interfaces. 4.2 adk 11/07/18 Added support for readback of PL
configuration data. 4.2 Nava 22/07/18 Added XFpga_SelectEndianess() new API to
Support programming the vivado generated .bit and .bin files 4.2 adk 03/08/18
Added example for partial reconfiguration. 4.2 Nava 16/08/18 Modified the PL
data handling Logic to support different PL programming interfaces. 4.2 Nava
15/09/18 Fixed global function call-backs issue. 5.0 Div 21/01/19 Fixed misra-c
required standard violations. 5.0 Nava 06/02/19 Remove redundant API's from the
interface agnostic layer and make the existing API's generic to support both
ZynqMP and versal platforms. 5.0 Nava 26/02/19 Fix for power-up PL issue with
pmufw. 5.0 Nava 26/02/19 Update the data handling logic to avoid the code
duplication 5.0 Nava 28/02/19 Handling all the 4 PS-PL resets irrespective of
the design configuration. 5.0 Nava 21/03/19 Added Address alignment check. As
CSUDMA expects word aligned address. In case user passes an unaligned address
return error. 5.0 sne 27/03/19 Fixed misra-c violations. 5.0 Nava 23/04/19
Optimize the API's logic to avoid code duplication. </pre> @note /

FILES:
lib/sw_services/xilfpga/src/interface/zynqmp/xilfpga_pcap.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 2.04a sdm 08/01/11 Added new parameter for Numonyx
quad flash devices. 3.00a srt 06/20/12 Updated to support interfaces SPI PS and
QSPI PS. Added support to SST flash. 3.00a srt 02/06/13 Changed the serial flash
family options to include Spansion flash (CR 696379). 5.1 sb 12/23/14 Added
Micron to the serial flash family options. 5.9 tjs 06/17/17 Changed the
description of serial_flash_interfaces and serial_flash_family.(CR 967359) 5.9
srm 02/16/18 Updated to pick up latest freertos port 10.0 5.11 tjs 03/16/18
Added ISSI to the serial flash family options. 5.13 sk 02/11/19 Added OSPI
interface support.

FILES:
lib/sw_services/xilisf/data/xilisf.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 2.01a sdm 06/17/10 Updated to support axi_spi 2.02a
sdm 09/24/10 updated to use Tcl commands instead of unix commands 2.03a sdm
04/17/11 Updated to support axi_quad_spi 2.04a sdm 08/01/11 Added new parameter
for Numonyx quad flash devices. 3.00a srt 06/20/12 Updated to support interfaces
SPI PS and QSPI PS. Added support to SST flash. 3.02a srt 05/13/13 Removed
compiler errors when not selecting proper interface for Zynq. (CR 716451) 5.4 sk
08/07/15 Updated to support QSPIPSU interface. Updated to support SPIPS
interface in ZynqMP. 5.13 sk 02/11/19 Added OSPI interface support. ISF_drc -
check system configuration and make sure all components to run ISF are
available.

FILES:
lib/sw_services/xilisf/data/xilisf.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_atmel_buffer_rdwr_example.c This file contains a design example using the
Xilinx In-system and Serial Flash Library (XilIsf). This example shows the
Buffer Write, Buffer to Page Program with Built-in Erase, Page to Buffer
Transfer and Buffer Read features. This example - Writes to a SRAM page buffer
using Buffer Write feature - Erase a Page and data is transferred to this page
from the SRAM page buffer using the Buffer to Page Program with Built-in Erase
feature. - Transfers the data to a SRAM Page using Page to Buffer Transfer
feature. - Reads back the Buffer that is written using the Buffer Read feature
and compares the data. The example works for
AT45DB011D/AT45DB021D/AT45DB041D/AT45DB081D Serial Flash devices. The bytes per
page (ISF_PAGE_SIZE) in these devices is 264 for Default addressing mode and 256
in Power-of-2 addressing mode. For AT45DB161D/AT45DB321D the Bytes Per Page
(ISF_PAGE_SIZE) is 528 for Default addressing mode and 512 in Power-Of-2
addressing mode. For AT45DB642D the Bytes Per Page (ISF_PAGE_SIZE) is 1056 for
Default addressing mode and 1024 in Power-Of-2 addressing mode. The
ISF_PAGE_SIZE should be defined by the user according to the Device used. For
further details of each device refer to the Spartan-3AN Serial Flash User Guide
and data sheets of Atmel AT45XXXD . This example has been tested with the In-
system Flash Memory available on the Spartan-3AN on a Xilinx Spartan-3AN Starter
Kit board. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------- -------- 1.00a ksu/sdm 03/22/08 First release 2.00a ktn 11/22/09 Updated
to use HAL processor APIs. 5.0 sb 08/05/14 Registering to Xilisf Interrupt
handler instead of driver handler. 5.14 akm 08/01/19 Initialized Status variable
to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_atmel_buffer_rdwr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_atmel_rdwr_polled_example.c This file contains a design example using the
In-system and Serial Flash Library (XilIsf) with the Spi driver in polled mode
of operation. This example shows the Erase, Read and Write features. This
example - Erases a Page - Writes to the erased Page - Reads back the Page that
is written and compares the data The example works for
AT45DB011D/AT45DB021D/AT45DB041D/AT45DB081D Serial Flash devices. The bytes per
page (ISF_PAGE_SIZE) in these devices is 264 for Default addressing mode and 256
in Power-of-2 addressing mode. For AT45DB161D/AT45DB321D devices the Bytes Per
Page (ISF_PAGE_SIZE) is 528 for Default addressing mode and 512 in Power-Of-2
addressing mode. For AT45DB642D device the Bytes Per Page (ISF_PAGE_SIZE) is
1056 for Default addressing mode and 1024 in Power-Of-2 addressing mode. The
ISF_PAGE_SIZE should be defined by the user according to the Device used. For
further details of each device refer to the Spartan-3AN Serial Flash User Guide
and data sheets of Atmel AT45XXXD . This example has been tested with the In-
System Flash Memory available on the Spartan-3AN on a Xilinx Spartan-3AN Starter
Kit board. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 1.00a sdm 04/02/08 First release 2.00a ktn 11/22/09 The Spi Driver
APIs have changed. Replaced the call to XSpi_mIntrGlobalDisable with
XSpi_IntrGlobalDisable. 5.14 akm 08/01/19 Initialized Status variable to
XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_atmel_rdwr_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_atmel_read_write_example.c This file contains a design example using the
In-system and Serial Flash Library (XilIsf). This example shows the Erase, Read
and Write features. This example - Erases a Page - Writes to the erased Page -
Reads back the Page that is written and compares the data. The example works for
AT45DB011D/AT45DB021D/AT45DB041D/AT45DB081D Serial Flash devices. The bytes per
page (ISF_PAGE_SIZE) in these devices is 264 for Default addressing mode and 256
in Power-of-2 addressing mode. For AT45DB161D/AT45DB321D devices the Bytes Per
Page (ISF_PAGE_SIZE) is 528 for Default addressing mode and 512 in Power-Of-2
addressing mode. For AT45DB642D device the Bytes Per Page (ISF_PAGE_SIZE) is
1056 for Default addressing mode and 1024 in Power-Of-2 addressing mode. The
ISF_PAGE_SIZE should be defined by the user according to the Device used. For
further details of each device refer to the Spartan-3AN Serial Flash User Guide
and data sheets of Atmel AT45XXXD . This example has been tested with the In-
System Flash Memory available on the Spartan-3AN on a Xilinx Spartan-3AN Starter
Kit board. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------- -------- 1.00a mta/ksu 03/20/08 First release 2.00a ktn 11/22/09 Updated
to use HAL processor APIs. 5.0 sb 08/05/14 Registering to Xilisf Interrupt
handler instead of driver handler. 5.14 akm 08/01/19 Initialized Status variable
to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_atmel_read_write_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_atmel_spr_example.c This
file contains a design example using the In-system and Serial Flash Library
(XilIsf). This example shows all the features related to Sector Protection. This
example - Writes to the Sector Protection Register - Reads the Sector Protection
Register and compares with the data that was written - Erases the Sector
Protection Register - Erases a Page and writes the data to the Page - Enables
the Sector Protection so that all the sectors are Write protected - Erases a
Page (This should not happen as the Sectors are Write protected - Reads back the
Page that is written and compares the data. The example works for
AT45DB011D/AT45DB021D/AT45DB041D/AT45DB081D Serial Flash devices. The bytes per
page (ISF_PAGE_SIZE) in these devices is 264 for Default addressing mode and 256
in Power-of-2 addressing mode. For AT45DB161D/AT45DB321D devices the Bytes Per
Page (ISF_PAGE_SIZE) is 528 for Default addressing mode and 512 in Power-Of-2
addressing mode. For AT45DB642D device the Bytes Per Page (ISF_PAGE_SIZE) is
1056 for Default addressing mode and 1024 in Power-Of-2 addressing mode. The
ISF_PAGE_SIZE should be defined by the user according to the Device used. For
further details of each device refer to the Spartan-3AN Serial Flash User Guide
and data sheets of Atmel AT45XXXD . This example has been tested with the In-
System Flash Memory available on the Spartan-3AN on a Xilinx Spartan-3AN Starter
Kit board. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------- -------- 1.00a mta/ksu 03/20/08 First release 1.00a ktn 09/08/09 Updated
this example such that every SPR write should be preceded by an erase as per the
atmel datasheet. 2.00a ktn 11/22/09 Updated to use HAL processor APIs. 5.0 sb
08/05/14 Registering to Xilisf Interrupt handler instead of driver handler. 5.14
akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_atmel_spr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_intel_otp_rdwr_example.c
This file contains a design example using the Xilinx In-system and Serial Flash
Library (XilIsf). This example shows the One-Time Programmable (OTP) Read/Write
features. This example - Writes a Byte to OTP region - Reads back the Byte
written to the OTP region and compares the data This example has been tested
with Intel (Numonyx) Serial Flash Memory (S33) on a S3A-DSP starter kit. For
further details about the S33 Flash device refer to the Intel (Numonyx) Serial
Flash Memory (S33) Data sheets. @note None. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00a sdm 03/24/08 First release 2.00a ktn
11/22/09 Updated to use HAL processor APIs. 5.0 sb 08/05/14 Registering to
Xilisf Interrupt handler instead of driver handler. 5.14 akm 08/01/19
Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_intel_otp_rdwr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_intel_rdwr_polled_example.c This file contains a design example using the
Xilinx In-system and Serial Flash Library (XilIsf) with the Spi driver in polled
mode of operation. This example shows the Sector Protection Register Read,
Sector Protection Register Write, Sector Erase, Read and Write features. This
example - Disables the Sector Protection for all the Sectors - Erases a Sector -
Writes to a Page within the Erased Sector - Reads back the Page that is written
and compares the data. This example has been tested with Intel (Numonyx) Serial
Flash Memory (S33) on a S3A-DSP starter kit. For further details about the S33
Flash device refer to the Intel (Numonyx) Serial Flash Memory (S33) Data sheets.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.00a sdm 04/02/08 First release 2.00a ktn 11/22/09 The Spi Driver APIs have
changed. Replaced the call to XSpi_mIntrGlobalDisable with
XSpi_IntrGlobalDisable. 5.14 akm 08/01/19 Initialized Status variable to
XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_intel_rdwr_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_intel_read_write_example.c This file contains a design example using the
Xilinx In-system and Serial Flash Library (XilIsf). This example shows the
Sector Protection Register Read, Sector Protection Register Write, Sector Erase,
Read and Write features. This example - Disables the Sector Protection for all
the Sectors - Erases a Sector - Writes to a Page within the Erased Sector -
Reads back the Page that is written and compares the data. This example has been
tested with Intel (Numonyx) Serial Flash Memory (S33) on a S3A-DSP starter kit.
For further details about the S33 Flash device refer to the Intel (Numonyx)
Serial Flash Memory (S33) Data sheets. @note None. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a sdm 03/17/08 First release 2.00a
ktn 11/22/09 Updated to use HAL processor APIs. 5.0 sb 08/05/14 Registering to
Xilisf Interrupt handler instead of driver handler. 5.14 akm 08/01/19
Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_intel_read_write_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_intel_spr_example.c This
file contains a design example using the Xilinx In-system and Serial Flash
Library (XilIsf). This example shows the usage of Sector Erase, Sector
Protection, Read and Write features. This example - Disables the Sector
Protection for all the Sectors - Erases a Sector - Writes to a Page within the
erased Sector - Enables the Sector Protection so that all the sectors are Write
protected - Erases the Sector (This should not happen as the Sectors are Write
protected - Reads the Status Register and checks if the Erase Fail Flag is set -
Clears the Status Register Fail Flags - Reads back the Page that is written and
compares the data. This example has been tested with Intel (Numonyx) Serial
Flash Memory (S33) on a S3A-DSP starter kit. For further details about the S33
Flash device refer to the Intel (Numonyx) Serial Flash Memory (S33) Data sheets.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sdm 03/17/08 First release 2.00a ktn 11/22/09 Updated to use HAL processor
APIs. 5.0 sb 08/05/14 Registering to Xilisf Interrupt handler instead of driver
handler. 5.14 akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre>
Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_intel_spr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_ospipsv_flash_intr_example.c This file contains a design example using
the XILISF Library in interrupt mode with a serial FLASH device. @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 5.13 sk
02/11/19 First release 5.14 akm 08/01/19 Initialized Status variable to
XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_ospipsv_stm_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_ospipsv_flash_polled_example.c This file contains a design example using
the XILISF Library in polled mode with a serial FLASH device. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 5.13 sk 02/11/19
First Release. 5.14 akm 08/01/19 Initialized Status variable to XST_FAILURE.
</pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_ospipsv_stm_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_qspips_flash_intr_example.c This file contains a design example using the
XILISF Library in interrupt mode with a serial FLASH device. This examples
performs some transfers in Auto mode and Manual start mode, to illustrate the
modes available. The hardware which this example runs on, must have a serial
FLASH (Numonyx N25Q, Winbond W25Q, or Spansion S25FL) for it to run. This
example has been tested with the Numonyx Serial Flash (N25Q128). @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00 srt
06/20/12 First release 1.01 srt 04/26/13 Modified Erase function to perform
Write Enable operation for each sector erase. 1.01 srt 08/28/13 Fixed the CR
731919, by setting the proper QSPI options. 5.0 sb 08/05/14 Added support for
greater than 128MB flash operations. 5.14 akm 08/01/19 Initialized Status
variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_qspips_stm_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_qspips_flash_polled_example.c This file contains a design example using
the XILISF Library in interrupt mode with a serial FLASH device. This examples
performs some transfers in Auto mode and Manual start mode, to illustrate the
modes available. The hardware which this example runs on, must have a serial
FLASH (Numonyx N25Q, Winbond W25Q, or Spansion S25FL) for it to run. This
example has been tested with the Numonyx Serial Flash (N25Q128). @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.00 srt
06/20/12 First release 1.01 srt 04/26/13 Modified Erase function to perform
Write Enable operation for each sector erase. 1.01 srt 08/28/13 Fixed the CR
731919, by setting the proper QSPI options. 5.0 sb 08/05/14 Added support for
greater than 128MB flash operations. 5.14 akm 08/01/19 Initialized Status
variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_qspips_stm_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_qspipsu_flash_intr_example.c This file contains a design example using
the XILISF Library in interrupt mode with a serial FLASH device. This examples
performs some transfers in Auto mode and Manual start mode, to illustrate the
modes available. The hardware which this example runs on, must have a serial
FLASH (Numonyx N25Q, Winbond W25Q, or Spansion S25FL) for it to run. This
example has been tested with the Numonyx Serial Flash (N25Q128). @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 5.4 sk
08/07/15 First release 5.7 rk 07/27/16 Added the dummy bytecnt other than normal
reads. 5.14 akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre>
Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_qspipsu_stm_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_qspipsu_flash_polled_example.c This file contains a design example using
the XILISF Library in interrupt mode with a serial FLASH device. This examples
performs some transfers in Auto mode and Manual start mode, to illustrate the
modes available. The hardware which this example runs on, must have a serial
FLASH (Numonyx N25Q, Winbond W25Q, or Spansion S25FL) for it to run. This
example has been tested with the Numonyx Serial Flash (N25Q128). @note None.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 5.4 sk
08/07/15 First Release. 5.7 rk 07/27/16 Added the dummy bytecnt other than
normal reads. 5.14 akm 08/01/19 Initialized Status variable to XST_FAILURE.
</pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_qspipsu_stm_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_spips_flash_intr_example.c This file contains a design example using the
XILISF Library in interrupt mode with a serial FLASH device. This examples
performs some transfers in Auto mode and Manual start mode, to illustrate the
modes available. The hardware which this example runs on, must have a serial
FLASH (Numonyx N25Q, Winbond W25Q, SST or Spansion S25FL) for it to run. This
example has been tested with the SST Flash. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.00 srt 06/20/12 First release
3.01 srt 03/03/13 Modified the flash write, erase and read logic. Ensured flash
blocks are unprotected before a flash erase or write operation. (CR 703816) 3.02
srt 04/26/13 Modified Erase function to perform Write Enable operation for each
sector erase. 5.0 sb 08/05/14 Registering to Xilisf Interrupt handler instead of
driver handler. 5.4 sk 08/07/15 Modified the example to support on ZynqMP. 5.14
akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_spips_sst_intr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_spips_flash_polled_example.c This file contains a design example using
the XILISF Library in interrupt mode with a serial FLASH device. This examples
performs some transfers in Auto mode and Manual start mode, to illustrate the
modes available. The hardware which this example runs on, must have a serial
FLASH (Numonyx N25Q, Winbond W25Q, SST or Spansion S25FL) for it to run. This
example has been tested with the SST Flash. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.00 srt 06/20/12 First release
3.01 srt 03/03/13 Modified the flash write, erase and read logic. Ensured flash
blocks are unprotected before a flash erase or write operation. (CR 703816) 3.02
srt 04/26/13 Modified Erase function to perform Write Enable operation for each
sector erase. 5.4 sk 08/07/15 Modified the example to support on ZynqMP. 5.14
akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_spips_sst_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_stm_quad_flash_example.c
This file contains a design example using the In-system and Serial Flash Library
(XilIsf) for Reading/Writing to a STM (Numonyx) N25QXX Quad Serial Flash Device.
This example shows the Erase, Dual/Quad Read and Dual/Quad Write features. This
example - Erases a Sector - Writes to a Page within the Erased Sector - Reads
back the Page that is written and compares the data This example has been tested
with a Numonyx Serial Flash Memory (N25Q128) on a Xilinx KC705 board. For
further details about the Flash device refer the Numonyx Serial Flash Memory
(N25Q128) data sheet. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 2.04a sdm 08/25/11 First release 3.02a adk 07/08/13
Fixed the CR 721229, by setting the proper QSPI options. 5.0 sb 08/05/14
Registering to Xilisf Interrupt handler instead of driver handler. 5.14 akm
08/01/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_stm_quad_flash_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_stm_rdwr_polled_example.c This file contains a design example using the
In-system and Serial Flash Library (XilIsf) for Reading/Writing to a STM
(Numonyx) M25P16 Serial Flash Device with the Spi driver in polled mode of
operation. This example shows the Erase, Read and Write features. This example -
Erases a Sector - Writes to a Page within the Erased Sector - Reads back the
Page that is written and compares the data. This example has been tested with a
STM (Numonyx) M25P16 device on a Xilinx Spartan-3A Starter Kit board and AC701
board with a Micron flash N25Q256A (32MB, supporting 4 Byte addressing mode).
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- --- --------
1.00a sdm 04/02/08 First release 2.00a ktn 11/22/09 The Spi Driver APIs have
changed. Replaced the call to XSpi_mIntrGlobalDisable with
XSpi_IntrGlobalDisable. 5.2 asa 05/12/15 Added support for Micron N25Q256A flash
part which supports 4 byte addressing. 5.5 sk 01/14/16 Added support for
Spansion flash in extended address mode. 5.14 akm 08/01/19 Initialized Status
variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_stm_rdwr_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_stm_read_write_example.c
This file contains a design example using the In-system and Serial Flash Library
(XilIsf) for Reading/Writing to a STM (Numonyx) M25P16 Serial Flash Device. This
example shows the Erase, Read and Write features. This example - Erases a Sector
- Writes to a Page within the Erased Sector - Reads back the Page that is
written and compares the data This example has been tested with a STM (Numonyx)
M25P16 device on Xilinx Spartan-3A Starter Kit board. @note None. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a sdm
03/17/08 First release 2.00a ktn 11/22/09 Updated to use HAL processor APIs. 5.0
sb 08/05/14 Registering to Xilisf Interrupt handler instead of driver handler.
5.2 asa 05/12/15 Added support for Micron N25Q256A flash. 5.5 sk 01/14/16 Added
support for Spansion flash in extended address mode. 5.6 sk 05/12/16 Corrected
the missing WE before erase. CR 951694. 5.14 akm 08/01/19 Initialized Status
variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_stm_read_write_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_stm_spr_example.c This
file contains a design example using the Xilinx In-system and Serial Flash
Library (XilIsf). This example shows the usage of Sector Erase, Sector
Protection, Read and Write features. This example - Erases a Sector - Writes to
a Page within the erased Sector - Enables the Sector Protection so that all the
sectors are Write protected - Erases a Page (This should not happen as the
Sectors are Write protected - Reads back the Page that is written and compares
the data. This example has been tested with a STM (Numonyx) Serial Flash Memory
(M25P16) on a Xilinx Spartan-3A Starter Kit board. For further details about the
Flash device refer to the STM (Numonyx) Serial Flash Memory (M25P16) data sheet.
@note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- --------
1.00a sdm 03/17/08 First release 2.00a ktn 11/22/09 Updated to use HAL processor
APIs. 5.0 sb 08/05/14 Registering to Xilisf Interrupt handler instead of driver
handler. 5.14 akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre>
Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_stm_spr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_winbond_quad_flash_example.c This file contains a design example using
the In-system and Serial Flash Library (XilIsf) for Reading/Writing to a Winbond
W25QXX Quad Serial Flash Device. This example shows the Erase, Dual/Quad Read
and Quad Write features. This example - Erases a Sector - Writes to a Page
within the Erased Sector - Reads back the Page that is written and compares the
data This example has been tested with a Winbond Serial Flash Memory (W25Q64) on
a Xilinx SP605 board. For further details about the Flash device refer the
Winbond Serial Flash Memory (W25Q64) data sheet. @note None. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 2.04a sdm 08/25/11 First
release 5.0 sb 08/05/14 Registering to Xilisf Interrupt handler instead of
driver handler. 5.14 akm 08/01/19 Initialized Status variable to XST_FAILURE.
</pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_winbond_quad_flash_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_winbond_rdwr_polled_example.c This file contains a design example using
the In-system and Serial Flash Library (XilIsf) for Reading/Writing to a Winbond
W25QXX/W25XX Serial Flash Device with the Spi driver in polled mode of
operation. This example shows the Erase, Read and Write features. This example -
Erases a Sector - Writes to a Page within the Erased Sector - Reads back the
Page that is written and compares the data This example has been tested with a
Winbond Serial Flash Memory (W25Q64) on a Xilinx SP605 board. For further
details about the Flash device refer the Winbond Serial Flash Memory (W25Q64)
data sheet. @note None. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
--- -------- 2.01a sdm 03/17/10 First release 5.14 akm 08/01/19 Initialized
Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_winbond_rdwr_polled_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilisf_winbond_read_write_example.c This file contains a design example using
the In-system and Serial Flash Library (XilIsf) for Reading/Writing to a Winbond
W25QXX/W25XX Serial Flash Device. This example shows the Erase, Read and Write
features. This example - Erases a Sector - Writes to a Page within the Erased
Sector - Reads back the Page that is written and compares the data This example
has been tested with a Winbond Serial Flash Memory (W25Q64) on a Xilinx SP605
board. For further details about the Flash device refer the Winbond Serial Flash
Memory (W25Q64) data sheet. @note None. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 2.01a sdm 03/17/10 First release 5.0 sb 08/05/14
Registering to Xilisf Interrupt handler instead of driver handler. 5.14 akm
08/01/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_winbond_read_write_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_winbond_spr_example.c
This file contains a design example using the Xilinx In-system and Serial Flash
Library (XilIsf). This example shows the usage of Sector Erase, Sector
Protection, Read and Write features on a Winbond W25QXX/W25XX Serial Flash
Device. This example - Erases a Sector - Writes to a Page within the erased
Sector - Enables the Sector Protection so that all the sectors are Write
protected - Erases a Page (This should not happen as the Sectors are Write
protected - Reads back the Page that is written and compares the data This
example has been tested with a Winbond Serial Flash Memory (W25Q64) on a Xilinx
SP605 board. For further details about the Flash device refer the Winbond Serial
Flash Memory (W25Q64) data sheet. @note None. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 2.01a sdm 03/17/10 First release 5.0 sb
08/05/14 Registering to Xilisf Interrupt handler instead of driver handler. 5.14
akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre> Include Files /

FILES:
lib/sw_services/xilisf/examples/xilisf_winbond_spr_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilisf.c This file contains
the library functions to initialize, control and read the device information of
the Serial Flash devices. Refer xilisf.h for detailed description. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 1.00a ksu/sdm
03/03/08 First release 1.00a sdm 07/02/08 Changed the initialization so that the
SPI Master works in Spi Mode 3 as the In-System Flash works only in Spi Mode 3
2.00a ktn 11/27/09 Updated to use HAL processor APIs/definitions 2.01a sdm
01/04/10 Added Support for Winbond W25QXX/W25XX devices The parameter
PagesPerBlock in the struct IntelStmDeviceGeometry has been renamed to
PagesPerSector. 2.03a sdm 04/17/10 Updated to support Winbond memory W25Q128.
2.04a sdm 08/17/10 Updated to support Numonyx (N25QXX) and Spansion flash
memories 3.00a srt 06/20/12 Updated to support interfaces SPI PS and QSPI PS.
New API: XIsf_RegisterInterface() XIsf_SetSpiConfiguration()
XIsf_SetTransferMode() Changed API: XIsf_Initialize() XIsf_Transfer() Added
support to SST flash. 3.01a srt 02/06/13 Updated for changes made in QSPIPS
driver (CR 698107). 5.0 sb 08/05/14 Updated for support for > 128 MB flash for
PSQSPI Interface. Added Library Handler API which will register to driver
interrupts, based upon the interface selected. New API:
SpaMicWinFlashInitialize() GetRealAddr() SendBankSelect()
XIsf_SetStatusHandler() void XIsf_IfaceHandler() Changed API: -
XIsf_Initialize() Added Call back to lib interrupt handler after XIsf_Transfer
Call - XIsf_Transfer() - XIsf_GetStatus() - XIsf_GetStatusReg2() -
XIsf_GetDeviceInfo() - XIsf_WriteEnable() - XIsf_Ioctl() 5.1 sb 12/23/14 Added
check for flash interface for Winbond, Spansion and Micron flash family for
PSQSPI. 5.2 asa 05/12/15 Added APIs to support 4 byte addressing for Micron
flash. 2 APIs were added, one to enter into 4 byte mode and the other to exit
from the same. 5.3 sk 08/07/17 Added QSPIPSU flash interface support for ZynqMP.
5.4 nsk 09/14/15 Updated IntelStmDevices list to support Micron N25Q256A (CR
881478). 5.5 sk 01/14/16 Updated IntelStmDevices list to add support for
S25FL512S and S25FL256S. sk 03/02/16 Added support for MT25QU01G. 5.9 ms
08/03/17 Added tags and modified comment lines style for doxygen. 5.10 tjs
11/30/17 Added description of S25FL-L series flash parts in IntelStmDevices
array. CR 987566 5.10 tjs 03/01/18 Added MT25Q512 3V and 1.8V flash part
support. CR 995477 5.11 tjs 03/16/18 Added support for ISSI flash part. 5.12 tjs
05/02/18 Added support for IS25LP064A and IS25WP064A. 5.12 tjs 06/05/18 Added
support for Macronix 1G flash parts. CR978447 5.12 tjs 06/18/18 Removed
checkpatch and gcc warnings. 5.12 tjs 06/18/18 Added support for MT25QL01G and
MT25QL02G 3V flash.CR1004264 5.12 tjs 06/18/18 Added support for low density
ISSI flash parts. PR9237 5.13 nsk 01/22/19 Make variable declaration to
XQspiPsu_Msg as global CR1015808. 5.13 akm 01/30/19 Fixed multiple definition
error in C++ project CR1019773 sk 02/11/19 Added support for OSPI flash
interface. 5.13 akm 02/26/19 Added support for ISSI serial NOR Flash Devices. PR
11442 sk 02/28/19 Added support for SST26WF016B flash. 5.14 akm 08/01/19
Initialized Status variable to XST_FAILURE. </pre> / Include Files /

FILES:
lib/sw_services/xilisf/src/xilisf.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilisf_erase.c This file
contains the library functions to Erase the Serial Flash. Refer xilisf.h for a
detailed description. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
------- -------- 1.00a ksu/sdm 03/03/08 First release 2.01a sdm 01/04/10 Added
Support for Winbond W25QXX/W25XX devices 2.04a sdm 08/17/10 Updated to support
Numonyx (N25QXX) and Spansion flash memories 3.02a srt 04/25/13 Added Bulk Erase
command support for SST and Spansion flashes. 5.0 sb 08/05/14 Updated support
for > 128 MB flash for PSQSPI interface. New API: DieErase() Changed API:
SectorErase() BulkErase() 5.2 asa 05/12/15 Added support for Micron (N25Q256A)
flash part which supports 4 byte addressing. 5.3 sk 08/07/17 Added QSPIPSU flash
interface support for ZynqMP. 5.5 sk 01/14/16 Used 4byte erase command in 4 byte
addressing mode. sk 03/02/16 Used 3byte command with 4 byte addressing for
Micron. 5.7 rk 27/07/16 Added the subsector erase command. 5.9 nsk 07/11/17 Add
Micron 4Byte addressing support in SectorErase, CR980169 ms 08/03/17 Added tags
and updated comment lines style for doxygen. 5.12 tjs 05/21/18 Removed the check
for address to be non zero CR1002769 5.12 tjs 06/18/18 Removed checkpatch and
gcc warnings. 5.12 tjs 07/05/18 Removed the mentions of Spansion flash from
BlockErase API CR1006247 5.13 nsk 01/22/18 Make variable declaration to
XQspiPsu_Msg as global CR1015808. sk 02/11/19 Added support for OSPI flash
interface. sk 02/15/19 4B Sector erase command is not supported by all QSPI
Micron flashes hence used used 3B sector erase command. </pre> / Include Files /

FILES:
lib/sw_services/xilisf/src/xilisf_erase.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilisf_read.c This file
contains the library functions to read data from the Serial Flash devices. Refer
xilisf.h for detailed description. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------- -------- 1.00a ksu/sdm 03/03/08 First release 2.01a sdm
01/04/10 Added Support for Winbond W25QXX/W25XX devices 2.04a sdm 08/17/10
Updated to support Numonyx (N25QXX) and Spansion flash memories 5.0 sb 08/05/14
Updated support for > 128 MB flash for PSQSPI interface. Changed API: ReadData()
FastReadData() 5.2 asa 05/12/15 Added support for Micron (N25Q256A) flash part
which supports 4 byte addressing. 5.3 sk 06/01/15 Used Half of Actual byte count
for calculating Real Byte count in parallel mode. CR 859979. 5.3 sk 08/07/17
Added QSPIPSU flash interface support for ZynqMP. 5.5 sk 01/14/16 Used 4byte
Fast read command in 4 byte addressing mode. 5.8 nsk 03/02/17 Update WriteBuffer
index to 10 in FastReadData, CR968476 5.9 nsk 97/11/17 Add Micron 4Byte
addressing support in Xisf_Read, CR980169 ms 08/03/17 Added tags and modified
comment lines style for doxygen. 5.12 tjs 05/21/18 Added check for Spansion
flash before proceeding to quad mode read CR1002769 5.12 tjs 06/18/18 Removed
checkpatch and gcc warnings. 5.13 nsk 01/22/18 Make variable declaration to
XQspiPsu_Msg as global CR1015808. sk 02/11/19 Added support for OSPI flash
interface. 5.14 akm 08/01/19 Initialized Status variable to XST_FAILURE. </pre>
/ Include Files /

FILES:
lib/sw_services/xilisf/src/xilisf_read.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilisf_spr.c This file
contains the library functions to operate on Sector Protection feature of the
Serial Flash. Refer xilisf.h for a detailed description. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------- -------- 1.00a ksu/sdm 03/03/08
First release 2.01a sdm 01/04/10 Added Support for Winbond W25QXX/W25XX devices
2.04a sdm 08/17/10 Updated to support Numonyx (N25QXX) and Spansion flash
memories 5.0 sb 08/05/14 Added Call back to lib interrupt handler after
XIsf_Transfer Calls. Changed API: - XIsf_SectorProtect() 5.9 ms 08/03/17 Added
tags and updated comment lines style for doxygen. 5.12 tjs 06/18/18 Removed
checkpatch and gcc warnings. 5.14 akm 08/01/19 Initialized Status variable to
XST_FAILURE. </pre> / Include Files /

FILES:
lib/sw_services/xilisf/src/xilisf_spr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilisf_write.c This file
contains the library functions to write to the Serial Flash devices. Refer
xilisf.h for detailed description. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ------- -------- 1.00a ksu/sdm 03/03/08 First release 2.01a sdm
01/04/10 Added Support for Winbond W25QXX/W25XX devices 2.04a sdm 08/17/10
Updated to support Numonyx (N25QXX) and Spansion flash memories 3.00a srt
06/20/12 Updated to support interfaces SPI PS and QSPI PS. Added support to SST
flash on SPI PS interface. 5.0 sb 08/05/14 Updated support for > 128 MB flash
for PSQSPI interface. Changed API: WriteData() XIsf_Write() 5.2 asa 05/12/15
Added support for Micron (N25Q256A) flash part which supports 4 byte addressing.
5.3 sk 08/07/17 Added QSPIPSU flash interface support for ZynqMP. 5.5 sk
01/14/16 Used 4byte program command in 4 byte addressing mode. sk 03/02/16 Used
3byte command with 4 byte addressing for Micron. 5.9 nsk 07/11/17 Add Micron
4Byte addressing support in Xisf_Write, CR980169 ms 08/03/17 Added tags and
modified comment lines style for doxygen. 5.12 tjs 06/18/18 Removed checkpatch
and gcc warnings. 5.13 nsk 01/22/18 Make variable declaration to XQspiPsu_Msg as
global CR1015808. sk 02/15/19 4B write command is not supported by all QSPI
Micron flashes hence used used 3B write command. 5.14 akm 08/01/19 Initialized
Status variable to XST_FAILURE. </pre> / Include Files /

FILES:
lib/sw_services/xilisf/src/xilisf_write.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilisf.h @addtogroup
xilisf_apis Library-APIs @{ @cond xilisf_internal @{ The Xilinx In-system and
Serial Flash (XilIsf) Library supports the Xilinx In-system Flash and, external
Serial Flash Memories from Atmel (AT45XXXD), Intel (S33), ST Microelectronics
(STM) (M25PXX), Winbond (W25QXX/W25XX), Numonyx (N25QXX) devices. Intel (S33)
and STM (M25PXX) Serial Flash devices are now a part of Serial Flash devices
provided by Numonyx. Flash parts N25QXX are now known as Micron MT25QXX keeping
all the functionality same. <b>This library also supports the Spansion (S25FLXX)
devices, but this family hasn't been tested. The support for this family of
devices is limited to the common commands supported by the other flash
families</b> The following instructions are not supported in WinBond
(W25QXX/W25XX) Block Erase 32KB, Erase Suspend/Resume, Mode Bit Reset, Read
Unique ID, and Read Manufacturer/Device ID. The following instructions are not
supported in Numonyx (N25QXX)- Erase Suspend/Resume, Read/Write Volatile/Non-
volatile configuration register. <b>Library Description</b> The library enables
higher layer software (e.g. an application) to communicate with the Serial
Flash. The library allows the user to Write, Read and Erase the Serial Flash.
The user can also protect the data stored in Serial Flash from unwarranted
modification by enabling the Sector Protection feature. User can also perform
different Control operations on Intel, STM (Numonyx), Winbond and Spansion
Serial Flash devices. The library supports interrupt driven mode and polled mode
based on the mode in which the Spi driver is configured by the user. - Polled
Mode of operation: All the APIs are blocking in this mode. - Interrupt mode of
operation: It is the application's responsibility to acknowledge the associated
Interrupt Controller's interrupts. The transfer is initiated and the control is
given back to the user application. The user application has to keep track of
whether the initiated operation is completed successfully. This library can
support multiple instances of Serial Flash at a time, provided they are of the
same device family (either Atmel, Intel, STM or Spansion) as the device family
is selected at compile time. <b>Device Operation</b> The Serial Flash operates
as a slave device on the SPI bus, with Xilinx SPI core operating as the Master.
The library uses XSpi driver for communicating with the Serial Flash. <b>Device
Geometry</b> - Atmel (AT45XXXD)/Xilinx ISF: The Atmel Serial Flash is divided
into Sectors. Each Sector consists of multiple Blocks. Each Block contains
multiple Pages. Each Page contains multiple Bytes. The Number of Sectors, Blocks
Per Sector, Pages Per Block and Bytes Per Page vary for different devices within
this family. There are two addressing modes supported by the Atmel Serial Flash:
- Default-Addressing Mode. - Power-Of-2 Addressing mode. In Default Addressing
mode the Atmel Serial Flash contains approximately 3% more Addressing memory
than the Power-Of-2 addressing mode. The addressing mode of the Atmel Serial
Flash can be known by reading the Device Status Register The ISF in the Xilinx
devices is in Default-Addressing mode by default. The following Atmel flash
memories are supported by this library. AT45DB011D AT45DB021D AT45DB041D
AT45DB081D AT45DB161D AT45DB321D AT45DB642D - Intel (Numonyx) (S33) and STM
(Numonyx)(M25PXX): The Intel and STM Serial Flash is divided into Sectors. Each
Sector consists of multiple pages. Each Page contains 256 Bytes. The Number of
Sectors and Pages Per Sectors vary for different devices within this family. The
following Intel and STM flash memories are supported by this library. S3316MBIT
S3332MBIT S3364MBIT M25P05_A M25P10_A M25P20 M25P40 M25P80 M25P16 M25P32 M25P64
M25P128 - Winbond W25QXX/W25XX: The Winbond W25QXX/W25XX Serial Flash is divided
into Blocks of 64 KB and the blocks are divided into sectors. Each Sector
consists of multiple pages. Each Page contains 256 Bytes. The Number of Blocks
and Sectors vary for different devices within this family. The following
instructions are not supported - Block Erase 32KB, Erase Suspend/Resume, Mode
Bit Reset, Read Unique ID, and Read Manufacturer/Device ID. The following
Winbond flash memories are supported by this library. W25Q80 W25Q16 W25Q32
W25Q64 W25Q128 W25X10 W25X20 W25X40 W25X80 W25X16 W25X32 W25X64 - Numonyx N25QXX
The Numonyx N25QXX Serial Flash is divided into sectors of 64 KB and the sectors
are divided into sub-sectors. Each Sector consists of multiple pages. Each Page
contains 256 Bytes. The Number of Blocks vary for different devices within this
family. The following instructions are not supported - Erase Suspend/Resume,
Read/Write Volatile/Non-volatile configuration register. The following Numonyx
flash memories are supported by this library. N25Q32 N25Q64 N25Q128 N25Q256A -
Spansion S25FL The Spansion S25FL Serial Flash is divided into sectors of 64 KB
and in devices like S25FL128/129, the sectors are divided into sub-sectors. Each
Sector consists of multiple pages. Each Page contains 256 Bytes. The Number of
Blocks vary for different devices within this family. The following Spansion
flash memories are supported by this library. S25FL004 S25FL008 S25FL016
S25FL032 S25FL064 S25FL128/129 - Silicon Storage Technology (SST) SST25WF080 The
SST25WF080 Serial Flash is divided into sectors of 4KB. This flash doesn't
support Page Write commands. Supports only Byte-Write Command. Support for new
parts can be easily added, when they are available from vendors. <b>Library
Initialization</b> The function call XIsf_Initialize() should be called by the
application before using any other function in the library. This function will
fetch the Manufacturer code and Device code and determine the geometry of the
Serial Flash used. <b>Write Operations</b> The XIsf_Write() API is used to write
data to the Serial Flash. A maximum of a Page of data can be written using this
API. Once the user initiates a write operation, the Serial Flash takes time to
complete the write operation internally. The user has to read the Status
Register (XIsf_GetStatus) to know if the Serial Flash is still busy with a
previously initiated operation before initiating a new one. Using the
XIsf_Write() API the user can perform several different types of write
operations as mentioned below: - Normal Write: Write data to the specified
locations in the Serial Flash. This operation is supported in Atmel, Intel, STM,
Winbond and Spansion Serial Flash. - Dual Input Fast Program: This operation is
similar to the Normal Write operation, except that the data is transmitted on
two lines (DQ0 and DQ1) instead of one. This operation is supported in Numonyx
(N25QXX) Quad Serial Flash. - Dual Input Extended Fast Program: This operation
is similar to the Dual Input Fast Program, except that the address is
transmitted on two lines (DQ0 and DQ1) instead of one. This operation is
supported in Numonyx (N25QXX) Quad Serial Flash. - Quad Input Fast Program: This
operation is similar to the Dual Input Fast Program, except that the data is
transmitted on four lines (DQ0 - DQ3) instead of two. This operation is
supported in Numonyx (N25QXX), Winbond (W25QXX) and Spansion (S25FL129) Quad
Serial Flash. - Quad Input Extended Fast Program: This operation is similar to
the Quad Input Fast Program, except that the address is transmitted on four
lines (DQ0 - DQ3) instead of one. This operation is supported in Numonyx
(N25QXX) Quad Serial Flash. - Auto Page Write: Auto rewrite the contents of the
page. This operation is supported only for Atmel Serial Flash. - Buffer Write:
Write data to the internal SRAM buffer of the Serial Flash. This operation is
supported only for Atmel Serial Flash. - Buffer To Memory Write With Erase:
Write data from the specified SRAM buffer to a page in the Serial Flash after
erasing the page. This operation is supported only for Atmel Serial Flash. -
Buffer To Memory Write Without Erase: Write data from the specified SRAM buffer
to a Page in the Serial Flash without erasing the page. This operation is
supported only for Atmel Serial Flash. - Write Status Register: Write to the
Status Register of the Serial Flash. This operation is supported only for Intel,
STM, Winbond and Spansion Serial Flash. - Write 2 byte Status Register: Write to
the 16-bit Status Register of the Serial Flash. This operation is supported only
for Winbond Serial Flash. - One Time Programmable Area Write: Write one byte of
data in to One Time Programmable area. This operation is supported only for
Intel Serial Flash. For Intel, STM (Numonyx), Winbond and Spansion Serial Flash
devices, the user application must call the XIsf_WriteEnable() API by passing
XISF_WRITE_ENABLE as an argument before calling the Isf_Write() API. <b>Read
Operations</b> The XIsf_Read() API can be used to read a minimum of one byte and
a maximum of an entire array of the Serial Flash depending on the type of read
operation. Using the XIsf_Read() API the user can perform several different
types of read operations as mentioned below: - Normal Read: Read data from the
specified locations in the Serial Flash . This operation is supported for Atmel,
Intel, STM, Winbond and Spansion Serial Flash. - Fast Read: Read a large block
of contiguous data from the specified locations of the Serial Flash at a higher
speed than the Normal Read. This operation is supported for Atmel, Intel, STM,
Winbond and Spansion Serial Flash. - Dual Output Fast Read: This operation is
similar to the Fast Read, except that the data is transmitted on two lines (DQ0
and DQ1) instead of one. This operation is supported in Numonyx (N25QXX),
Winbond (W25QXX) and Spansion (S25FL129) Quad Serial Flash. - Dual Input/Output
Fast Read: This operation is similar to the Dual Output Fast Read, except that
the address is transmitted on two lines (DQ0 and DQ1) instead of one. This
operation is supported in Numonyx (N25QXX), Winbond (W25QXX) and Spansion
(S25FL129) Quad Serial Flash. - Quad Output Fast Read: This operation is similar
to the Dual Output Fast Read, except that the data is transmitted on four lines
(DQ0 - DQ3) instead of two. This operation is supported in Numonyx (N25QXX),
Winbond (W25QXX) and Spansion (S25FL129) Quad Serial Flash. - Quad Input/Output
Fast Read: This operation is similar to the Quad Output Fast Program, except
that the address is transmitted on four lines (DQ0 - DQ3) instead of one. This
operation is supported in Numonyx (N25QXX), Winbond (W25QXX) and Spansion
(S25FL129) Quad Serial Flash. - Memory To Buffer Transfer: Transfer a page of
data from the Serial Flash to the specified internal SRAM buffer of the Serial
Flash. This operation is supported only in Atmel Serial Flash. - Buffer Read:
Read data from the specified SRAM internal buffer of the Serial Flash. This
operation is supported only in Atmel Serial Flash. - Fast Buffer Read: Read
multiple contiguous bytes from the internal SRAM page buffer of Serial Flash at
a higher speed than normal Buffer Read. This operation is supported only for
Atmel Serial Flash. - One Time Programmable Area Read: Read One Time
Programmable area. This operation is supported only for Intel Serial Flash.
<b>Erase Operations</b> The XIsf_Erase() API can be used to Erase the contents
of the Serial Flash. Once the user initiates an Erase operation, the Serial
Flash takes time to complete the Erase operation internally. The user has to
read the Status Register to know if Serial Flash is still busy with a previously
initiated operation before initiating a new one. Using the XIsf_Erase() API the
user can perform four different types of Erase operations as mentioned below : -
Page Erase: Erase one Page of the Serial Flash. This operation is supported only
for Atmel Serial Flash. - Block Erase: Erase one Block of the Serial Flash. This
operation is supported for Atmel, Intel, Winbond Serial Flash. - Sector Erase:
Erase one Sector of the Serial Flash. This operation is supported for Atmel,
Intel, STM, Spansion and Winbond Serial Flash. - Bulk Erase: Erase an entire
Serial Flash. This operation is supported for Intel, STM, Winbond and Spansion
Serial Flash. For Intel, STM, Winbond and Spansion Serial Flash the user
application must call the XIsf_WriteEnable() API by passing XISF_WRITE_ENABLE as
an argument before calling the XIsf_Erase() API. <b>Sector Protection
Operations</b> The XIsf_SectorProtect() API can be used to perform Sector
Protection related operations. The Serial Flash is divided into Sectors. Each
Sector or number of Sectors can be protected from unwarranted writing/erasing.
Using the XIsf_SectorProtect() API the user can perform five different type of
operations as given below: - Sector Protect Register Read: Read Sector Protect
Register/Bits in to the buffer provided by user. This operation is supported for
Atmel, Intel, STM, Winbond and Spansion Serial Flash. - Sector Protect Register
Write: Write data to the Sector Protect Register/Bits. This operation is
supported for Atmel, Intel, STM, Winbond and Spansion Serial Flash. - Sector
Protect Register Erase: Erase the Sector Protect Register. This operation is
supported only for Atmel Serial Flash. - Sector Protect Enable: Enable Sector
Protect mode of Serial Flash. This operation is supported only for Atmel Serial
Flash. - Sector Protect Disable: Disable Sector Protect mode of Serial Flash.
This operation is supported only for Atmel Serial Flash. For Intel, STM, Winbond
and Spansion Serial Flash the user application must call the XIsf_WriteEnable()
API by passing XISF_WRITE_ENABLE as an argument before calling the
XIsf_SectorProtect() API for Sector Protect Register Write operation. <b>Device
Control Operations</b> The XIsf_Ioctl() API can be used to perform control
operations on the Intel, STM, Winbond and Spansion Serial Flash. Using the
XIsf_Ioctl() API the user can perform several different types of operations as
given below: - Release From Deep Power-Down Mode: This operation releases the
Serial Flash from Deep Power-Down Mode. This operation is supported for Intel,
STM, Winbond and Spansion Serial Flash. - Enter to Deep Power-Down Mode: This
operation puts the Serial Flash in to Deep Power-Down Mode. In this mode all
commands except the release from Deep Power-Down Mode command will be ignored.
This operation is supported for Intel, STM, Winbond and Spansion Serial Flash. -
Clear Status Register Fail Flag: This operation clears all the fail flags in the
Status Register of the Serial Flash. This operation is only supported for Intel
Serial Flash. - High Performance Mode: This instruction must be executed before
the dual/quad I/O instructions in Winbond Flash. This instruction is supported
only in Winbond (W25QXX) Serial Flash. <b>Serial Flash Information Read</b>
XIsf_GetDeviceInfo() API is used to read the Joint Electron Device Engineering
Council (JEDEC) compatible device information. This JEDEC information consists
of Manufacturer ID, Vendor-Specific Device family identifier, Vendor-Specific
device identifier for the specified family, number of bits stored per memory
cell, product version and number of additional Extended Device Information
bytes. Read the Spartan-3AN In-system Flash User Guide and the data sheets of
Atmel-AT45XXXD/STM-M25PXX/Intel-S33/Winbond-W25QXX/W25XX/Spansion-S25FLXX for
more information. XIsf_GetStatus() API is used to read the Status Register of
the Serial Flash. Winbond devices have a Status Register 2 which can be read
using the XIsf_GetStatusReg2() API. <b>Write Enable/Disable Operations</b> For
Intel, STM, Winbond and Spansion Serial Flash the user application must enable
the Write to the Serial Flash by calling XIsf_WriteEnable (XISF_WRITE_ENABLE)
API before doing any Write operations to Serial Flash. Writing to the Serial
Flash is disabled by calling XIsf_WriteEnable (XISF_WRITE_DISABLE) API. @note
This library is intended to be RTOS and processor independent. It works with
physical addresses only. Any needs for dynamic memory management, threads,
mutual exclusion, virtual memory or cache control must be satisfied by the layer
above this driver. This library supports the Spansion (S25FLXX) devices, but
this family hasn't been tested. The support for this family of devices is
limited to the common commands supported by the other flash families. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 1.00a ksu/sdm
03/03/08 First release 2.00a ktn 11/27/09 Updated to use HAL processor
APIs/definitions 2.01a sdm 01/04/10 Added Support for Winbond W25Q80/16/32
devices 2.01a sdm 06/17/10 Updated the Tcl to support axi_spi 2.03a sdm 04/17/10
Updated to support Winbond memory W25Q128 and added a list of supported flash
memories Updated the Tcl to support axi_quad_spi 2.04a sdm 08/17/10 Updated to
support Numonyx (N25QXX) and Spansion flash memories 3.00a srt 06/20/12 Updated
to support interfaces SPI PS and QSPI PS. New API: XIsf_RegisterInterface()
XIsf_SetSpiConfiguration() XIsf_SetOperatingMode() Changed API:
XIsf_Initialize() XIsf_Transfer() Added support to SST flash. 3.01a srt 02/06/13
Updated for changes made in QSPIPS driver (CR 698107). APIs changed:
XQspiPs_PolledTransfer() XQspiPs_Transfer() XQspiPs_SetSlaveSelect(). Modified
the examples xilisf_spips_sst_intr_example.c and
xilisf_spips_sst_polled_example.c to correct the flash write, erase and read
logic. (CR 703816) 3.02a srt 04/25/13 - Added Bulk Erase command support for SST
and Spansion flashes (CR 703816 & 711003). - Modified SECTOR and BLOCK Erase
commands for SST flash and updated spips examples. (CR 703816) - Updated spips
and qspips examples to perform Write enable operation in each sector - Removed
compiler errors when not selecting proper interface for Zynq. (CR 716451) 5.0 sb
08/05/14 - Updated for support for > 128 MB flash for PSQSPI Interface. - Added
Library Handler API which will register to driver interrupts, based upon the
interface selected. New API: GetRealAddr() SendBankSelect()
XIsf_SetStatusHandler() XIsf_IfaceHandler() 5.1 sb 12/23/14 Added check for
flash interface for Winbond, Spansion and Micron flash family for PSQSPI. 5.2
asa 5/12/15 Added support for Micron N25Q256A (>16MB) flash devices. This meant
adding necessary support for 4 byte addressing mode. APIs were added to enter
and exit from 4 byte mode. Changes were made in read, erase and write APIs to
support 4 byte mode. These were done to fix CR858950. 5.3 sk 06/01/15 Used Half
of Actual byte count for calculating Real Byte count in parallel mode. CR
859979. 5.3 sk 08/07/17 Added QSPIPSU flash interface support for ZynqMP. 5.4
nsk 09/14/15 Updated IntelStmDevices list in xilisf.c to support Micron
N25Q256A.CR881478. 5.5 sk 11/07/15 Removed Compilation warnings with SPI
interface. CR 868893. 5.7 rk 27/07/16 Added the SubSector erase option. 5.8 nsk
03/02/17 Update WriteBuffer index to 10 in FastReadData, CR968476 5.9 nsk
07/11/17 Add 4Byte addressing support for Micron, CR980169 tjs 08/09/17 Updated
the calculation of RealByteCount for reading data from flash with TESTADDRESS
being 0x00000000, CR981795 ms 08/03/17 Added doxygen tags. 5.10 tjs 11/30/17
Added S25FL-L series flash parts support. CR 987566 5.10 tjs 03/11/17 Added
MT25Q512 3V and 1.8V flash part support. CR 995477 5.11 tjs 03/16/18 Added
support for ISSI flash part. 5.12 tjs 05/02/18 Added support for IS25LP064A and
IS25WP064A. 5.12 tjs 05/21/18 Removed the check for address to be non zero.
Added check for Spansion flash before proceeding to quad mode read CR1002769
5.12 tjs 06/05/18 Added support for Macronix 1G flash parts. CR978447 5.12 tjs
06/18/18 Removed checkpatch and gcc warnings. 5.12 tjs 07/16/18 Updated notes
for Micron flash parts. CR973229 5.12 tjs 06/18/18 Added support for low density
ISSI flash parts. PR9237 5.12 tjs 08/13/18 Fixed the compilation warnings for
ARMCC (CR1008307) 5.13 nsk 01/22/19 Make variable declaration to XQspiPsu_Msg as
global CR1015808. 5.13 akm 01/30/19 Fixed multiple definition error in C++
project CR1019773 sk 02/11/19 Added support for OSPI flash interface. 5.13 akm
02/26/19 Added support for ISSI serial NOR Flash Devices. PR 11442 sk 02/28/19
Added support for SST26WF016B flash. sk 02/28/19 Used 3B Sector erase and write
commands for QSPI Micron flashes. 5.14 akm 08/01/19 Initialized Status variable
to XST_FAILURE. </pre> /

FILES:
lib/sw_services/xilisf/src/include/xilisf.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilisf_atmel.h This file
contains the definitions to be used when accessing the Atmel AT45XXXD Serial
Flash. If any new definitions are added to this file, check if they need to be
added to the xilisf_intelstm.h file too. @note None <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------- -------- 1.00a ksu/sdm 03/03/08 First release
</pre>

FILES:
lib/sw_services/xilisf/src/include/xilisf_atmel.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilisf_intelstm.h This file
contains the definitions to be used when accessing the Intel, STM, Winbond and
Spansion Serial Flash. If any new definitions are added to this file, check if
they need to be added to the xilisf_atmel.h file too. @note None <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------- -------- 1.00a ksu/sdm
03/03/08 First release 2.01a sdm 01/04/10 Added Support for Winbond W25QXX/W25XX
devices 2.04a sdm 08/17/10 Updated to support Numonyx (N25QXX) and Spansion
flash memories 3.00a srt 06/20/12 Updated to support interfaces SPI PS and QSPI
PS. Added support to SST flash on SPI PS interface. 3.02a srt 04/26/13 Modified
SECTOR and BLOCK Erase commands for SST flash (CR 703816). 5.2 asa 05/12/15
Added macros for 4 byte commands. 5.5 sk 01/14/16 Updated IntelStmDevices list
to add support for S25FL512S and S25FL256S. sk 03/02/16 Added support for
MT25QU01G. 5.7 rk 27/07/16 Added Subsector erase command. 5.10 tjs 11/30/17
Added JEDEC ID info for S25FL-L series flashes CR 987566 5.10 tjs 03/01/18 Added
MT25Q512 3V and 1.8V flash part support. CR 995477 5.11 tjs 03/16/18 Added
support for ISSI flash parts. 5.12 tjs 05/02/18 Added support for IS25LP064A and
IS25WP064A. 5.12 tjs 06/05/18 Added support for Macronix 1G flash parts.
CR978447 5.12 tjs 06/18/18 Added support for MT25QL01G and MT25QL02G 3V
flash.CR1004264 5.12 tjs 06/18/18 Removed warnings reported by checkpatch. 5.12
tjs 06/18/18 Added support for low density ISSI flash parts. PR9237 5.13 akm
02/26/19 Added support for ISSI serial NOR Flash Devices. PR 11442 5.13 sk
02/28/19 Added support for SST26WF016B flash. </pre> /

FILES:
lib/sw_services/xilisf/src/include/xilisf_intelstm.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 ww 05-31-18 Initial Release

FILES:
lib/sw_services/xillibpm/data/xillibpm.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 ww 05/31/18 Initial Release libpm_drc

FILES:
lib/sw_services/xillibpm/data/xillibpm.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xillibpm_err.h This is the
header file which contains status codes for the PLM, PLMI and loader. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 Amit
05/08/2019 Initial release </pre> @note

FILES:
lib/sw_services/xillibpm/src/common/xillibpm_err.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Naming Convention:
<MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE> Module name (e.g. can or usb)
<REGISTER> Register within the current module [_<FIELD>] Bit field within a
register [_<DESC>] Type of bit field define: SHIFT: Least significant bit for
the field WIDTH: Size of field in bites MASK: A masking over a range of bits or
a bit to be used for setting or clearing

FILES:
lib/sw_services/xillibpm/src/server/xpm_regs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 kc 09/26/2018 Initial Release

FILES:
lib/sw_services/xilloader/data/xilloader.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 kc 09/22/18 Initial Release loader_drc

FILES:
lib/sw_services/xilloader/data/xilloader.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader.c This file contains
the code related to PDI image loading. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 07/25/2018 Initial release </pre> @note
Include Files /

FILES:
lib/sw_services/xilloader/src/xloader.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader.h This file contains
declarations for image store functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 07/24/2018 Initial release </pre> @note

FILES:
lib/sw_services/xilloader/src/xloader.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_cfi.c This file
contains the code related to PDI image loading. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 bsv 06/17/2019 Initial release </pre>
@note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_cfi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_cmd.c This file
contains the xloader commands implementation. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 03/12/2019 Initial release </pre>
@note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_cmd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_ddr.c This is the file
which contains DDR init and copy functions related code for the platform loader.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc
03/12/2019 Initial release </pre> @note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_ddr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_ddr.h This is the
header file which contains DDR interface declarations for the xilloader. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc
03/12/2019 Initial release </pre> @note

FILES:
lib/sw_services/xilloader/src/xloader_ddr.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_intr.c This file
contains the code related to the interrupt handling. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 03/25/2019 Initial release
</pre> @note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_intr.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_ospi.c This is the file
which contains ospi related code for the PLM. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 bsv 08/23/2018 Initial release </pre>
@note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_ospi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_ospi.h This is the
header file which contains ospi declarations for the PLM. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_services/xilloader/src/xloader_ospi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_prtn_load.c This is the
file which contains partition load code for the Platform loader.. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc
02/21/2017 Initial release </pre> @note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_prtn_load.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_qspi.c This is the file
which contains qspi related code for the PLM. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 02/21/2018 Initial release </pre>
@note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_qspi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_qspi.h This is the
header file which contains qspi declarations for the PLM. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2018 Initial
release </pre> @note

FILES:
lib/sw_services/xilloader/src/xloader_qspi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_sbi.c This is the file
which contains SBI related code for the platform loader. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 09/21/2017 Initial
release </pre> @note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_sbi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_sbi.h This is the
header file which contains qspi declarations for the PLM. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_services/xilloader/src/xloader_sbi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_sd.c This is the file
which contains sd related code for the PMC FW. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 09/21/2017 Initial release </pre>
@note Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_sd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_sd.h This is the header
file which contains qspi declarations for the PLM. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2018 Initial release
</pre> @note

FILES:
lib/sw_services/xilloader/src/xloader_sd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_secure.c This file
contains all security functionality operations. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.0 vns 04/23/19 First release </pre> @note
Include Files /

FILES:
lib/sw_services/xilloader/src/xloader_secure.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xloader_secure.h This file
contains all security related data. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 vns 04/23/19 First release </pre> @note

FILES:
lib/sw_services/xilloader/src/xloader_secure.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 adk 12/02/19 Initial Release adk 06/03/19
Updated supported peripheral option with A72 and PMC.

FILES:
lib/sw_services/xilmailbox/data/xilmailbox.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.0 adk 12/02/19 Initial Release 1.0 adk 22/03/19
Add versal GIC IP name in interrupt controller check mailbox_drc

FILES:
lib/sw_services/xilmailbox/data/xilmailbox.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilmailbox_example.c This
example demonstrates the usage of mailbox library API's. Each IPI channel can
trigger an interrupt to itself and can exchange messages through the message
buffer. This feature is used here to exercise the library APIs. Example control
flow: - Initialize the XMailbox instance - Write a Message and Trigger IPI to
Self in Blocing mode. - Interrupt handler receives IPI and Sends back response.
- Read the received response and do a sanity check. - Print PASS or FAIL based
on sanity check of response message Include Files /

FILES:
lib/sw_services/xilmailbox/examples/xilmailbox_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilmailbox.c @addtogroup
xilmailbox_v1_0 @{ @details This file contains the definitions for xilinx
mailbox library top level functions. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 adk 14/02/19 Initial Release </pre> @note /
Include Files /

FILES:
lib/sw_services/xilmailbox/src/xilmailbox.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilmailbox.h @addtogroup
xilmailbox_v1_0 @{ @details The XilMailbox library provides the top-level hooks
for sending or receiving an inter-processor interrupt (IPI) message using the
Zynq® UltraScale+ MPSoC IPI hardware. For a full description of IPI features,
please see the hardware spec. This library supports the following features: -
Triggering an IPI to a remote agent. - Sending an IPI message to a remote agent.
- Callbacks for error and recv IPI events. - Reading an IPI message. <b>
Software Initialization </b> - IPI Initialization using XMailbox_Initalize()
function. This step initializes a library instance for the given IPI channel. -
XMailbox_Send() function triggers an IPI to a remote agent. -
XMailbox_SendData() function sends an IPI message to a remote agent, Message
type should be either XILMBOX_MSG_TYPE_REQ (OR) XILMBOX_MSG_TYPE_RESP. -
XMailbox_Recv() function reads an IPI message from a specified source agent,
Message type should be either XILMBOX_MSG_TYPE_REQ (OR) XILMBOX_MSG_TYPE_RESP. -
XMailbox_SetCallBack() using this function user can register call backs for recv
and error events. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.0 adk 14/02/19 Initial Release adk 06/03/19 In the mld file updated
supported peripheral option with A72 and PMC. </pre> @note /

FILES:
lib/sw_services/xilmailbox/src/xilmailbox.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilmailbox_ipips.c
@addtogroup xilmailbox_v1_0 @{ @details This file contains the definitions for
ZynqMP and versal IPI implementation. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 adk 14/02/19 Initial Release </pre> @note /
Include Files /

FILES:
lib/sw_services/xilmailbox/src/PS/xilmailbox_ipips.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilmailbox_ipips.h
@addtogroup xilmailbox_v1_0 @{ @details <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 adk 12/02/19 Initial Release </pre> @note /

FILES:
lib/sw_services/xilmailbox/src/PS/xilmailbox_ipips.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

XILINX IS PROVIDING THIS DESIGN, CODE, OR INFORMATION "AS IS" AS A COURTESY TO
YOU, SOLELY FOR USE IN DEVELOPING PROGRAMS AND SOLUTIONS FOR XILINX DEVICES. BY
PROVIDING THIS DESIGN, CODE, OR INFORMATION AS ONE POSSIBLE IMPLEMENTATION OF
THIS FEATURE, APPLICATION OR STANDARD, XILINX IS MAKING NO REPRESENTATION THAT
THIS IMPLEMENTATION IS FREE FROM ANY CLAIMS OF INFRINGEMENT, AND YOU ARE
RESPONSIBLE FOR OBTAINING ANY RIGHTS YOU MAY REQUIRE FOR YOUR IMPLEMENTATION.
XILINX EXPRESSLY DISCLAIMS ANY WARRANTY WHATSOEVER WITH RESPECT TO THE ADEQUACY
OF THE IMPLEMENTATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OR
REPRESENTATIONS THAT THIS IMPLEMENTATION IS FREE FROM CLAIMS OF INFRINGEMENT,
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. (c)
Copyright 2002, 2003 Xilinx Inc. All rights reserved. Flash Writer for the
Toshiba TH50VSF2580/2581AASB and TH50VSF3680/3681AASB Flash Memory Base Address.
This should be set to the value in the current system as specified in .mhs file.

FILES:
lib/sw_services/xilmfs/src/utils/flash.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 kc 11/16/17 Initial Release

FILES:
lib/sw_services/xilpdi/data/xilpdi.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 kc 11/16/17 Initial Release pdi_drc

FILES:
lib/sw_services/xilpdi/data/xilpdi.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilpdi.c This is the C file
which contains APIs for reading PDI image. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 12/21/2017 Initial release </pre> @note
Include Files /

FILES:
lib/sw_services/xilpdi/src/xilpdi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PRTNICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilpdi.h This is the header
file which contains definitions for the PDI. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 12/21/2017 Initial release </pre> @note

FILES:
lib/sw_services/xilpdi/src/xilpdi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 kc 9/22/2018 Initial Release

FILES:
lib/sw_services/xilplmi/data/xilplmi.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 kc 09/22/18 Initial Release plmi_drc

FILES:
lib/sw_services/xilplmi/data/xilplmi.tcl
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S): [EPL-1.0]

COPYRIGHT TEXT:
---------------

(c) 2013 Xilinx Inc. XREGDB v0.91 XREGCHDR v0.15 Generated on: 2018-10-30 @file:
pmc_global.h This file contains confidential and proprietary information of
Xilinx, Inc. and is protected under U.S. and international copyright and other
intellectual property laws. DISCLAIMER This disclaimer is not a license and does
not grant any rights to the materials distributed herewith. Except as otherwise
provided in a valid license issued to you by Xilinx, and to the maximum extent
permitted by applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND
WITH ALL FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and
(2) Xilinx shall not be liable (whether in contract or tort, including
negligence, or under any other theory of liability) for any loss or damage of
any kind or nature related to, arising under or in connection with these
materials, including for any direct, or any indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any
type of loss or damage suffered as a result of any action brought by a third
party) even if such damage or loss was reasonably foreseeable or Xilinx had been
advised of the possibility of the same. CRITICAL APPLICATIONS Xilinx products
are not designed or intended to be fail safe, or for use in any application
requiring fail-safe performance, such as life-support or safety devices or
systems, Class III medical devices, nuclear facilities, applications related to
the deployment of airbags, or any other applications that could lead to death,
personal injury, or severe property or environmental damage (individually and
collectively, "Critical Applications"). Customer assumes the sole risk and
liability of any use of Xilinx products in Critical Applications, subject only
to applicable laws and regulations governing limitations on product liability.
THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE AT
ALL TIMES. Naming Convention: <MODULE>_<REGISTER>[_<FIELD>[_<DESC>]] <MODULE>
Module name (e.g. can or usb) <REGISTER> Register within the current module
[_<FIELD>] Bit field within a register [_<DESC>] Type of bit field define:
SHIFT: Least significant bit for the field WIDTH: Size of field in bites MASK: A
masking over a range of bits or a bit to be used for setting or clearing /

FILES:
lib/sw_services/xilplmi/src/pmc_global.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi.c This file contains the
PLMI module register functions. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 02/07/2019 Initial release </pre> @note Include
Files /

FILES:
lib/sw_services/xilplmi/src/xplmi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi.h This file contains
declarations PLMI module. <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 kc 02/07/2019 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_cdo.c This file contains
code to handling the CDO Buffer. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 08/23/2018 Initial release </pre> @note
Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_cdo.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_cdo.h This is the file
which contains cdo related code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 08/23/2018 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_cdo.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_cmd.c This is the file
which contains . <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 kc 08/23/2018 Initial release </pre> @note Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_cmd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_cmd.h This is the file
which contains command execution code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 08/23/2018 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_cmd.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_config.h This is the
header file which contains PLM configuration for users. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_config.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_debug.c This is the file
which contains uart initialization code for the PLM. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 07/13/2018 Initial release
</pre> @note Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_debug.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file XPlmi_debug.h This file
contains the code to enable debug levels in PLM. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00a kc 07/13/2018 Initial release </pre>
@note

FILES:
lib/sw_services/xilplmi/src/xplmi_debug.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_dma.c This is the file
which contains PMC DMA interface code for the PLM. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 kc 12/21/2018 Initial release
</pre> @note Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_dma.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_dma.h This is the file
which contains common code for the PLM. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_dma.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_err.c This file contains
error management for the PLM. <pre> MODIFICATION HISTORY: Ver Who Date Changes
1.00 kc 02/12/2019 Initial release </pre> @note Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_err.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_generic.c This is the
file which contains general commands. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 08/23/2018 Initial release </pre> @note
Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_generic.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_generic.h This is the
file which contains . <pre> MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00 kc 08/23/2018 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_generic.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_gic_interrupts.c This
file is to handle the GIC interrupts <pre> MODIFICATION HISTORY: Ver Who Date
Changes 1.00 mg 10/08/2018 Initial release </pre> @note Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_gic_interrupts.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplm_gic_interrupts.h This is
the header file for xplm_gic_interrupts.c <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 mg 10/08/2018 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_gic_interrupts.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_hw.h This is the header
file which contains definitions for the hardware registers. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial
release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_ipi.c This is the file
which contains ipi manager code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 mg 10/09/2018 Initial release </pre> @note /
Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_ipi.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_ipi.h This is the header
file which contains definitions for the ipi manager <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00 mg 10/09/2018 Initial release
</pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_ipi.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_module.c This is the file
which contains module registration code. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 kc 08/23/2018 Initial release </pre> @note
Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_modules.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_modules.h This is the
header file which contains definitions for the modules <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc 08/20/2018 Initial
release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_modules.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_proc.c This file contains
the processor related code. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 02/07/2019 Initial release </pre> @note Include
Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_proc.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_proc.h This file contains
declarations for PROC C file in PLM. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 02/07/2019 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_proc.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_status.h This is the
header file which contains status codes for the PLM, PLMI and loader. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 kc
07/13/2018 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_status.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_task.c This file contains
code Task handling. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 kc 02/06/2019 Initial release </pre> @note Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_task.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_task.h This is the file
which contains command execution code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 kc 02/06/2019 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_task.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_util.c This file which
contains the code which interfaces with the CRP <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre>
@note Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_util.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_util.h This is the header
file PMC FW utilities code. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 1.00 kc 02/21/2017 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_util.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_sysmon.c This is the file
which contains SysMon manager code. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00 sn 07/01/2019 Initial release </pre> @note /
Include Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_sysmon.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_sysmon.h This is the
header file which contains definitions for the SysMon manager <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 sn 07/01/2019 Initial
release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_sysmon.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_err.h This is the file
which contains . <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ----
-------- 1.00 kc 05/23/2019 Initial release </pre> @note

FILES:
lib/sw_services/xilplmi/src/xplmi_err.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xplmi_err_cmd.c This file
contains error management commands code for the PLM. <pre> MODIFICATION HISTORY:
Ver Who Date Changes 1.00 kc 02/12/2019 Initial release </pre> @note Include
Files /

FILES:
lib/sw_services/xilplmi/src/xplmi_err_cmd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CONTENT Generic functions for gic
initialization and interrupt enabling /

FILES:
lib/sw_services/xilpm/examples/gic_setup.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CONTENT Timer peripheral driver. Code
is mostly reused from hello_ttc0_interrupt application. /

FILES:
lib/sw_services/xilpm/examples/timer.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CONTENT Timer interface, contains
function to initialize timer and global variable tick_count which stores total
number of interrupts generated by the timer. /

FILES:
lib/sw_services/xilpm/examples/timer.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CONTENT Assumptions: only PROCESSOR
core is executing this code, other cores in PROCESSOR subsystem are already
powered down. 1) PROCESSOR configures timer0 peripheral to generate interrupts.
2) PROCESSOR waits for few interrupts to be generated by the timer and then
initiates self suspend. Before calling pm_self_suspend APU has saved its context
(which is in this case only tick_count variable value) in CONTEXT memory.
Suspending of the PROCESSOR is followed by CONTEXT retention. 3) Timer is still
counting while PROCESSOR is suspended and the next timer interrupt causes
CONTEXT to be woken up by PMU. 4) Processor resumes its execution, meaning that
it restores value of tick_count from CONTEXT MEM and does not configure timer
again because it is already configured. PROCESSOR enables interrupts at the
processor level (CPSR) and handle timer interrupt that caused wake-up. 5)
PROCESSOR waits for few more timer interrupts and repeats the suspend procedure.
/

FILES:
lib/sw_services/xilpm/examples/xilpm_selfsuspend_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CONTENT Each PU client in the system
have such file with definitions of masters in the subsystem and functions for
getting information about the master. /

FILES:
lib/sw_services/xilpm/src/apu/pm_client.c
lib/sw_services/xilpm/src/rpu/pm_client.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. CONTENT File is specific for each PU
instance and must exist in order to port Power Management code for some new PU.
Contains PU specific macros and macros to be defined depending on the execution
environment. /

FILES:
lib/sw_services/xilpm/src/apu/pm_client.h
lib/sw_services/xilpm/src/rpu/pm_client.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_api_sys.c PM Definitions
implementation @addtogroup xpm_apis XilPM APIs @{ /

FILES:
lib/sw_services/xilpm/src/common/pm_api_sys.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_api_sys.h PM API System
implementation @addtogroup xpm_apis XilPM APIs Xilinx Power Management(XilPM)
provides Embedded Energy Management Interface (EEMI) APIs for power management
on Zynq&reg; UltraScale+&trade MPSoC. For more details about power management on
Zynq Ultrascale+ MPSoC, see the Zynq UltraScale+ MPSoC Power Management User
Guide (UG1199). For more details about EEMI, see the Embedded Energy Management
Interface (EEMI) API User Guide(UG1200). @{ /

FILES:
lib/sw_services/xilpm/src/common/pm_api_sys.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_callbacks.c @addtogroup
xpm_apis XilPM APIs @{ /

FILES:
lib/sw_services/xilpm/src/common/pm_callbacks.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_callbacks.h Callbacks
implementation - for xilpm internal purposes only /

FILES:
lib/sw_services/xilpm/src/common/pm_callbacks.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_clock.c PM Definitions
implementation @addtogroup xpm_apis XilPM APIs @{ /

FILES:
lib/sw_services/xilpm/src/common/pm_clock.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_clock.h PM Definitions of
clocks - for xilpm internal purposes only /

FILES:
lib/sw_services/xilpm/src/common/pm_clock.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_common.h Definitions of
commonly used macros and data types needed for PU Power Management. This file
should be common for all PU's. /

FILES:
lib/sw_services/xilpm/src/common/pm_common.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file pm_defs.h PM Definitions
implementation @addtogroup xpm_apis XilPM APIs @{ /

FILES:
lib/sw_services/xilpm/src/common/pm_defs.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 hk 27/01/14 Initial Release 1.00 srm 02/16/18
Updated to pick up latest freertos port 10.0 1.5 vns 02/27/18 Updated
description

FILES:
lib/sw_services/xilrsa/data/xilrsa.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00 hk 27/01/14 Initial Release 1.1 hk 04/16/14
Error out when processor is not cortexa9. CR 783276. 1.2 sk 01/28/16 Added
support for CortexA9 with Linaro Tool chain. rsa_drc

FILES:
lib/sw_services/xilrsa/data/xilrsa.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilrsa.h @addtogroup
xilrsa_apis XilRSA APIs and Descriptions @{ @cond xilrsa_internal This file
contains the RSA algorithm functions <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.0 hk 27/01/14 First release 1.4 vns 07/06/17 Added
dooxygen tags. </pre> @note

FILES:
lib/sw_services/xilrsa/src/include/xilrsa.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a ba 06/01/15 Initial Release 2.0 vns 11/28/16
Added support for PMU 2.2 vns 07/06/16 Added doxygen tags 3.0 vns 01/03/18
Modified boot image decryption API 3.0 srm 02/16/18 Updated to pick up latest
freertos port 10.0 3.1 vns 04/04/18 Updated AES example vns 04/13/18 Added
secure_environment user configurable parameter. 3.2 vns 04/30/18 Error code is
been added if data is greater than moduluss 4.0 arc 18/12/18 Fixed MISRA-C
violations vns 03/20/19 Added support for versal

FILES:
lib/sw_services/xilsecure/data/xilsecure.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a ba 06/01/15 Initial Release 1.2 vns 08/23/16
Added support for SHA2 by adding .a files 2.0 vns 11/28/16 Added support for PMU
2.0 srm 02/16/18 Updated to pick up latest freertos port 10.0 3.1 vns 04/13/18
Added user configurable macro secure environment 4.0 vns 03/20/19 Added support
for versal secure_drc

FILES:
lib/sw_services/xilsecure/data/xilsecure.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilsecure_aes_example.c
@addtogroup xsecure_apis XilSecure AES APIs @{ This example illustrates AES
usage for decryption of a encrypted partition created by bootgen. @note This
example requires downloading an encrypted single partition image to 0x04000000
in DDR memory, decrypted data will be updated at the same location, one can
modify this addresses by changing ImageOffset and DstinationAddr variables.
Example bif is: //arch zynqmp; split false; format BIN the_ROM_image: {
[aeskeyfile]aes.nky [keysrc_encryption]kup_key [encryption aes]data.bin }
Following key and IV should be provided in .nky file while creating the boot
image: Key 0 f878b838d8589818e868a828c8488808f070b030d0509010e060a020c0408000;
IV D2450E07EA5DE0426C0FA133; MODIFICATION HISTORY: <pre> Ver Who Date Changes
----- ------ -------- 1.00a ba 01/13/14 First Release 2.0 vns 01/17/17 For
CR-964195 added required .nky fields in the comments, also print for decryption
failure. 2.2 vns 07/06/16 Added doxygen tags 3.0 vns 02/27/18 Modified example
to decrypt the single partition image instead of FSBL partition in boot image.
3.1 vns 04/04/18 For CR-998923, if data is greater than 1MB size, decrypted data
is overwriting the part of source and decryption of image is failing, to fix
this modified destination address, from now on image is overwritten with
decrypted data. </pre> Include Files /

FILES:
lib/sw_services/xilsecure/examples/xilsecure_aes_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilsecure_rsa_example.c
@addtogroup xsecure_apis XilSecure RSA APIs @{ @note This example requires
downloading an RSA authenticated(SHA-3) boot image to a location in DDR memory.
MODIFICATION HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 1.00a
bameta 11/04/14 First Release 2.2 vns 07/06/16 Added doxygen tags 3.0 vns
01/23/18 Added SHA3 keccak padding selection as this example illustrates FSBL
partition authentication 4.0 vns 03/12/19 Modified function call
XSecure_RsaDecrypt to XSecure_RsaPublicEncrypt, as XSecure_RsaDecrypt is
deprecated. vns 03/26/19 Fixed compilation errors on IAR </pre> Include Files /

FILES:
lib/sw_services/xilsecure/examples/xilsecure_rsa_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilsecure_rsa_generic_example.c
@addtogroup xsecure_rsa_gen_apis XilSecure RSA GENERIC APIs @{ This example
illustrates RSA APIs usage, by taking some hash with PKCS padding. - Firstly
data will be decrypted with Private key and generates RSA signature also
verifies with expected signature. - Then signature will be encrypted with public
key and generates the actual data also verifies with actual data. MODIFICATION
HISTORY: <pre> Ver Who Date Changes ----- ------ -------- 2.2 vns 08/18/17 First
release. </pre> Include Files /

FILES:
lib/sw_services/xilsecure/examples/xilsecure_rsa_generic_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilsecure_sha_example.c
@addtogroup xsecure_sha3_example_apis XilSecure SHA3 API Example Usage @{ This
example illustrates the SHA3 hash calculation. MODIFICATION HISTORY: <pre> Ver
Who Date Changes ----- ------ -------- 1.00a bameta 11/05/14 First Release 2.2
vns 07/06/16 Added doxygen tags </pre> Include Files /

FILES:
lib/sw_services/xilsecure/examples/xilsecure_sha_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilsecure_simple_aes_example.c
@addtogroup xsecure_aes_example XilSecure AES API Example Generic Usage @{ @note
This example illustrates the usage of AES APIs, by encrypting the data with
provided key and IV and decrypt's the output of encrypted data and compares with
original data and checks for GCM tag match. MODIFICATION HISTORY: <pre> Ver Who
Date Changes ----- ------ -------- 2.0 vns 02/10/17 First Release 2.2 vns
07/06/16 Added doxygen tags 4.0 vns 03/26/19 Fixed compilation errors on IAR
</pre> Include Files /

FILES:
lib/sw_services/xilsecure/examples/xilsecure_simple_aes_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa.c This file
contains the implementation of the interface functions for RSA driver. Refer to
the header file xsecure_sha.h for more detailed information. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.0 ba 10/13/14 Initial
release 1.1 ba 12/11/15 Added support for NIST approved SHA-3 in 2.0 silicon 2.0
vns 03/15/17 Fixed compilation warning, and corrected SHA2 padding verification
for silicon version other than 1.0 2.2 vns 07/06/17 Added doxygen tags vns
17/08/17 Added APIs XSecure_RsaPublicEncrypt and XSecure_RsaPrivateDecrypt.As
per functionality XSecure_RsaPublicEncrypt is same as XSecure_RsaDecrypt. 3.1
vns 11/04/18 Added support for 512, 576, 704, 768, 992, 1024, 1152, 1408, 1536,
1984, 3072 key sizes, where previous verision has support only 2048 and 4096 key
sizes. 3.2 vns 04/30/18 Added check for private RSA key decryption, such that
only data to be decrypted should always be lesser than modulus 4.0 arc 18/12/18
Fixed MISRA-C violations. vns 21/12/18 Added RSA key zeroization after RSA
operation arc 03/06/19 Added input validations vns 03/12/19 Modified as part of
XilSecure code re-arch. psl 03/26/19 Fixed MISRA-C violation 4.1 kal 05/20/19
Updated doxygen tags </pre> @note Include Files /

FILES:
lib/sw_services/xilsecure/src/common/xsecure_rsa.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa.h @addtogroup
xsecure_rsa_apis XilSecure RSA APIs @{ @cond xsecure_internal This file contains
hardware interface related information for RSA device This driver supports the
following features: - RSA 4096 based decryption - verification/authentication of
decrypted data <b>Initialization & Configuration</b> The Rsa driver instance can
be initialized in the following way: - XSecure_RsaInitialize(XSecure_Rsa
InstancePtr, u8 EncText, u8 Mod, u8 ModExt, u8 ModExpo) The method used for RSA
decryption needs precalculated value off R^2 mod N which is generated by bootgen
and is present in the signature along with modulus and exponent. @note -The
format of the public key( modulus, exponent and precalculated R^2 mod N should
be same as specified by the bootgen -For matching, PKCS paddding scheme has to
be applied in the manner specified by the bootgen. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.0 ba 10/10/14 Initial release 2.2 vns
07/06/17 Added doxygen tags vns 17/08/17 Added APIs XSecure_RsaPublicEncrypt and
XSecure_RsaPrivateDecrypt.As per functionality XSecure_RsaPublicEncrypt is same
as XSecure_RsaDecrypt. 3.1 vns 11/04/18 Added support for 512, 576, 704, 768,
992, 1024, 1152, 1408, 1536, 1984, 3072 key sizes, where previous verision has
support only 2048 and 4096 key sizes. 3.2 vns 04/30/18 Added error code
XSECURE_RSA_DATA_VALUE_ERROR 4.0 arc 18/12/18 Fixed MISRA-C violations. vns
03/12/19 Modified as part of XilSecure code re-arch. Moved all macro definitions
and instance structure to xsecure_rsa_core.h </pre> @endcond

FILES:
lib/sw_services/xilsecure/src/common/xsecure_rsa.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_sha.c This file
contains the implementation of the interface functions for SHA driver. Refer to
the header file xsecure_sha.h for more detailed information. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 ba 08/10/14 Initial
release 2.0 vns 01/28/17 Added API to read SHA3 hash. 2.2 vns 07/06/17 Added
doxygen tags 3.0 vns 01/23/18 Added NIST SHA3 support. Added SSS configuration
before every CSU DMA transfer 3.2 ka 04/30/18 Modified SHa3 hash calculation
fuctionality to support the following features: - To support byte aligned data,
- To support non-word aligned address - And also fixed limitation of input data,
now size of input can be of any size. not limitted to 512MB. 4.0 arc 12/18/18
Fixed MISRA-C violations. arc 03/06/19 Added asserts to validate input params.
vns 03/12/19 Modified as part of XilSecure code re-arch. arc 03/20/19 Added time
outs and status info for API's. mmd 03/15/19 Refactored the code. psl 03/26/19
Fixed MISRA-C violation vns 03/30/19 Added error condition in XSecure_Sha3Finish
for for wrong pad selection 4.1 kal 05/20/19 Updated doxygen tags psl 07/02/19
Fixed Coverity warnings. mmd 07/05/19 Optimized the code </pre> @note Include
Files /

FILES:
lib/sw_services/xilsecure/src/common/xsecure_sha.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_sha.h @addtogroup
xsecure_sha3_apis SHA-3 @{ @cond xsecure_internal This file Contains the
function prototypes, defines and macros for the SHA-384 hardware module. This
driver supports the following features: - SHA-3 hash calculation
<b>Initialization & Configuration</b> The SHA-3 driver instance can be
initialized in the following way: - XSecure_Sha3Initialize(XSecure_Sha3
InstancePtr, XCsuDma CsuDmaPtr) A pointer to CsuDma instance has to be passed in
initialization as CSU DMA will be used for data transfers to SHA module. @note
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00 ba
11/05/14 Initial release 2.0 vns 01/28/17 Added API to read SHA3 hash. 2.2 vns
07/06/17 Added doxygen tags 3.0 vns 01/23/18 Added NIST SHA3 support. 4.0 arc
18/12/18 Fixed MISRA-C violations. vns 03/12/19 Modified as part of XilSecure
code re-arch. arc 03/20/19 Changed prototype of the functions return type as
void to u32. psl 03/26/19 Fixed MISRA-C violation 4.1 mmd 07/05/19 Optimized the
code </pre> @note @endcond

FILES:
lib/sw_services/xilsecure/src/common/xsecure_sha.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_sha_hw.h This file
contains SHA3 core hardware definitions. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 4.0 vns 03/09/19 Initial release </pre>
@endcond

FILES:
lib/sw_services/xilsecure/src/common/xsecure_sha_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_utils.c This file
contains common functionalities required for xilsecure library like functions to
read/write hardware registers, SSS switch configurations. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 4.0 vns 03/09/19 Initial
release psl 03/26/19 Fixed MISRA-C violation psl 04/05/19 Fixed IAR warnings.
</pre> Include Files /

FILES:
lib/sw_services/xilsecure/src/common/xsecure_utils.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_utils.h @addtogroup
xsecure_common_apis XILSECURE_UTILITIES @{ @cond xsecure_internal This file
contains common APIs which are used across the library. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ------ -------- 4.0 vns 03/12/19 Initial
Release 4.1 kal 05/20/19 Updated doxygen tags </pre> @endcond

FILES:
lib/sw_services/xilsecure/src/common/xsecure_utils.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_aes.c This file
contains AES hardware interface APIs <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- ---------- 1.0 vns 04/24/2019 Initial release </pre> @note
Include Files /

FILES:
lib/sw_services/xilsecure/src/versal/xsecure_aes.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_aes.h This file
contains AES hardware interface APIs <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- ---------- 1.0 vns 04/24/2019 Initial release </pre> @note

FILES:
lib/sw_services/xilsecure/src/versal/xsecure_aes.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_aes_hw.h This file
contains AES core hardware definitions of versal. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 4.0 vns 03/21/19 Initial release </pre>
@endcond

FILES:
lib/sw_services/xilsecure/src/versal/xsecure_aes_core_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_ecdsa.h @addtogroup
xsecure_ecdsa_apis XilSecure ECDSA APIs @{ @cond xsecure_internal <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 4.0 vns 03/27/19
First Release </pre> @endcond

FILES:
lib/sw_services/xilsecure/src/versal/xsecure_ecdsa.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xecdsa_rsa_hw.h This header
file contains RSA ECDSA core hardware register offsets of versal. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 4.0 vns
02/14/19 First Release </pre>

FILES:
lib/sw_services/xilsecure/src/versal/xsecure_ecdsa_rsa_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa_core.c This file
contains the implementation of the versal specific RSA driver. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 4.0 vns 03/18/19
Initial Release. </pre> @note Include Files /

FILES:
lib/sw_services/xilsecure/src/versal/xsecure_rsa_core.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa_core.h This file
contains Versal specific RSA core APIs. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 4.0 vns 03/09/19 Initial release </pre>

FILES:
lib/sw_services/xilsecure/src/versal/xsecure_rsa_core.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure.c This file contains
the implementation of the interface functions for secure library. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 1.0 DP 02/15/17
Initial release 2.2 vns 09/18/17 Added APIs to support generic functionality for
SHA3 and RSA hardware at linux level. Removed RSA-SHA2 authentication support
for loading linux image and dtb from u-boot, as here it is using SHA2 hash and
single RSA key pair authentication 3.0 vns 02/21/18 Added support for single
partition image authentication and/or decryption. 3.1 vns 04/13/18 Added device
key support even if authentication is not been enabled for single partition
image, when PMUFW is compiled by enabling secure environment variable in bsp
settings. ka 04/10/18 Added support for user-efuse revocation ka 04/18/18 Added
support for Zeroization of the memory in case of Gcm-Tag mismatch 3.2 ka
04/04/18 Added support for Sha3_Update, if the payload is not 4 bytes aligned.
ka 08/03/18 Added XSecure_Aes Api's to encrypt or decrypt data-blobs. ka
10/25/18 Added support to clear user key after use. 4.0 arc 18/12/18 Fixed
MISRA-C violations. arc 12/02/19 Added support for validate image format. rama
18/03/19 Fixed IAR compiler errors and warnings arc 03/20/19 Reading the return
value of the functions to validate 4.0 Nava 19/03/19 In the current
implementation, the SecureIv variable is sharing between xilfpga and Xilsecure
libraries. To avoid data sharing conflicts removed SecureIV shared variable
dependency. mmd 03/15/19 Refactored the code psl 03/26/19 Fixed MISRA-C
violation 4.1 psl 07/02/19 Fixed Coverity warning. mmd 07/05/19 Optimized the
code </pre> @note Include Files /

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure.h This is the header
file which contains secure library interface function prototype for
authentication and decryption of images. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 1.00 dp 02/15/17 Initial release 2.2 vns
09/18/17 Added APIs to support generic functionality for SHA3 and RSA hardware
at linux level. 3.0 vns 02/19/18 Added error codes and macros for secure image.
3.1 ka 04/10/18 Added support for user-efuse revocation ka 04/18/18 Added
support for Zeroization of the memory in case of Gcm-Tag mismatch 3.2 ka
08/03/18 Added XSecure_Aes Api's to encrypt or decrypt data-blobs. 4.0 arc
18/12/18 Fixed MISRA-C violation. arc 12/02/19 Added support for validate image
format. rama 18/03/19 Fixed IAR compiler errors and warnings psl 03/26/19 FIxed
MISRA_C violation </pre> @note

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_aes.c This file
contains the implementation of the interface functions for AES driver. Refer to
the header file xsecure_aes.h for more detailed information. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- --- -------- 1.00 ba 09/10/14 Initial
release 1.1 ba 11/10/15 Modified Key loading logic in AES encryption 1.1 ba
12/22/15 Added Chunking support in decryption 2.0 vns 01/28/17 Added APIs for
decryption which can be used for generic decryption. vns 02/03/17 Added APIs for
encryption in generic way. Removed existing XSecure_AesEncrypt API Modified
encryption and decryption APIs such that all inputs will be accepted in little
endian format(KEY, IV and Data). 2.2 vns 07/06/16 Added doxygen tags 3.0 vns
01/03/18 Modified XSecure_AesDecrypt() API to use key and IV placed in secure
header by bootgen to decrypt the actual partition. vns 02/19/18 Modified
XSecure_AesKeyZero() to clear KUP and AES key Added XSecure_AesKeyZero() call in
XSecure_AesDecrypt() API to clear keys. 4.0 arc 12/18/18 Fixed MISRA-C
violations. arc 03/06/19 Added asserts to validate input params vns 03/13/19 As
part of refactoring modified SSS configurations arc 03/20/19 Added time outs and
status info for API's. mmd 03/15/19 Refactored the code. psl 03/26/19 Fixed
MISRA-C violation 4.1 kal 05/20/19 Updated doxygen tags psl 07/02/19 Fixed
Coverity warning. mmd 07/05/19 Optimized the code </pre> @note Include Files /

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure_aes.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_aes.h @addtogroup
xsecure_aes_apis XilSecure AES APIs @{ @cond xsecure_internal This file contains
hardware interface related information for CSU AES device This driver supports
the following features: - AES decryption with/without keyrolling -
Authentication using GCM tag - AES encryption <b>Initialization &
Configuration</b> The Aes driver instance can be initialized in the following
way: - XSecure_AesInitialize(XSecure_Aes InstancePtr, XCsuDma CsuDmaPtr, u32
KeySel, u32 Iv, u32 Key) The key for decryption can be the device key or user
provided key. KeySel variable denotes the key to be used. In case the key is
user provided, key has to be provided in Key variable. If it is device key, the
key variable will be ignored and device key will be used The initial
Initialization vector will be used for decrypting secure header and block 0 of
given encrypted data. @note -The format of encrypted data(boot image) has to be
exactly as specified by the bootgen. Any encrypted data has to start with a
secure header first and then the data blocks. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 1.00 ba 10/10/14 Initial release 1.1 ba
11/10/15 Modified Key loading logic in AES encryption 2.0 vns 01/28/17 Added
APIs for decryption which can be used for decrypting data rather than a boot
image. vns 02/03/17 Added APIs for encryption in generic way. Modified existing
XSecure_AesEncrypt to XSecure_AesEncryptData, and added XSecure_AesEncryptInit
and XSecure_AesEncryptUpdate APIs for generic usage. 2.2 vns 07/06/16 Added
doxygen tags 3.0 vns 02/19/18 Added error code for key clear
XSECURE_CSU_AES_KEY_CLEAR_ERROR and timeout macro XSECURE_AES_TIMEOUT_MAX 3.1 ka
03/16/18 Added Zeroization of Aes Decrypted data in case of GCM_TAG_MISMATCH 4.0
arc 18/12/18 Fixed MISRA-C violations. arc 03/20/19 Changed prototype of the
functions void to u32 mmd 03/15/19 Defined AES Key Clear value psl 03/26/19
Fixed MISRA-C violation 4.1 mmd 07/05/19 Optimized the code </pre> @endcond

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure_aes.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_aes_hw.h This is the
header file which contains ZynqMP AES core hardware definitions. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 4.0 vns 03/11/19
Initial release </pre> @note

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure_aes_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa_core.c This file
contains the implementation of the ZynqMP specific RSA driver. Refer to the
header file xsecure_rsa_core.h for more detailed information. <pre> MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 4.0 vns 03/12/19 Initial
Release. arc 03/20/19 modified default status value to XST_FAILURE for
XSecure_RsaSignVerification() mmd 03/15/19 Refactored the code psl 03/26/19
Fixed MISRA-C violation </pre> @note Include Files /

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure_rsa_core.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa_core.h This file
contains zynqmp specific RSA core APIs. <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 4.0 vns 03/09/19 Initial release </pre>

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure_rsa_core.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xsecure_rsa_hw.h This file
contains ZynqMP RSA hardware core register offsets. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 4.0 vns 03/09/19 Initial release </pre>

FILES:
lib/sw_services/xilsecure/src/zynqmp/xsecure_rsa_hw.h
--------------------------------------------------------------------------------


COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a rpo 04/24/13 Initial Release 3.00 vns 31/07/15
Support is being added for Ultrascale and hence supported processors are a9 and
microblaze too. so supported peripherals option has been removed. 4.00 vns
09/10/15 Added DFT control bit programming for efusePS Zynq. Bbram and eFuse
programming fecility is provided for Zynq MP Platform. 5.00 vns 01/09/16 Added
Ultrascale BBRAM programming functionality. Modified Jtag_write_Ultrascale API
according to IEEE 1149.1 standard by adding TCK toggles. 6.0 vns 29/06/16 Added
margin 2 reads for Zynq PL and PS eFUSE programming. 6.1 vns 17/10/16 Added PUF
support 6.4 vns 02/19/18 Updated XilSKey_ZynqMp_EfusePs_Write() function to
reload cache after successful programming of requested eFUSE bits srm 02/26/18
Updated to pick up latest freertos port 10.0 6.5 vns 03/16/18 Modified BBRAM
functions for ZynqMP 6.7 arc 10/29/18 Fixed ARMCC compiler warnings 6.8 psl
06/26/19 Added support for user to add IDCODE, IR_length, SLR Nos, device series
for different devices.

FILES:
lib/sw_services/xilskey/data/xilskey.mld
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. Modification History Ver Who Date
Changes ----- ---- -------- 1.00a rpo 04/25/13 Initial Release 3.00 vns 30/07/15
Added macro in xparameters.h based on the processor 6.4 vns 02/27/18 Added
support for virtex and virtex ultrascale plus 6.7 psl 03/12/19 Disabled
compilation of code not required for zynqmp 6.8 psl 06/26/19 Added support for
user to add IDCODE, IR_length, SLR Nos, device series for different devices.
skey_drc

FILES:
lib/sw_services/xilskey/data/xilskey.tcl
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_bbram_example.c @note
Example illustrates the method of programming the AES key to BBRAM. The user key
should be mentioned in xilskey_input.h. BBRAM is a battery backed RAM and there
is no restriction on the number of times key can programmed. This algorithm only
wokrs when program and verify key are done together and in that order. .
Procedure: 1. Create a hardware project using the appropriate design. 2. Create
a BSP. 3. Create fsbl 4. Create an application project using bbram example and
xilskey_input.h 5. The 256 bit key to be programmed has to be mentioned 6. A
hardware setup which dedicates four MIO pins for JTAG signals should be used and
the MIO pins should be mentioned in xilskey_input.h There should be a method to
download this example and have the MIO pins connected to JTAG before running
this application. 7. Run the application which will program and verify the BBRAM
key 8. After programming and veifying the key, power off. 9. Place a BBRAM key
encrypted boot image in one of the boot devices, set the appropriate boot pins
and power on. 10. The bbram example will be run from DDR with the default
linker. 11. To run from OCM, modify the linker to map all sections to
ps7_ram_0_S_AXI_BASEADDR instead of ps7_ddr_0_S_AXI_BASEADDR. MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a hk 09/18/13 First
release 6.1 vns 10/25/16 Removed ForcePowerCycle and JtagDisable from Zynq BBRAM
configuration as they are not actually programming any control bit. 6.7 psl
03/20/19 Added BBRAM jtag server init function. psl 03/15/19 Moved
XilSKey_Bbram_JTAGServerInit function from example to library. 6.8 psl 05/21/19
Initialized SystemInitDone ,to indicate XilSKey_Bbram_JTAGServerInit status.
Include Files /

FILES:
lib/sw_services/xilskey/examples/xilskey_bbram_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilskey_bbram_ultrascale_example.c @note Example illustrates the method of
programming the AES key to Ultrascale BBRAM. The AES key to be programmed should
be mentioned in xilskey_bbram_ultrascale_input.h. BBRAM is a battery backed RAM
and there is no restriction on the number of times key can programmed. This
algorithm only works when program and verify key are done together and in that
order. Accessing Ultrascale microblaze 's BBRAM is done by using block RAM
initialization. Master Jtag primitive has to added to design i.e
MASTER_JTAG_inst instantiation have to performed and AXI GPIO pins has to be
connected to TDO, TDI, TMS and TCK signals of MASTER_JTAG primitive. All
Inputs(TDO) and All Outputs(TDI, TMS, TCK) of MASTER_JTAG can be connected as 1)
All Inputs to one channel All Outputs to other channel Valid example: All
Outputs connected to Channel 1 Input signal TDO also connected to channel 2 2)
All Inputs and All Outputs to same channel. Valid example: All Outputs connected
to Channel 1 Input signal TDO also connected to channel 1 3) But some of the
Outputs in one channel and some of them in different channel is not accepted.
Invalid example: All Outputs connected to Channel 1 Input signals (TDI, TMS)
connected to Channel 1 Input signal TCK also connected to channel 2 The design
should only contain AXI bram Ctrl memory mapped(1MB). Note: MASTER_JTAG will
disable all other JTAGs Procedure to access BBRAM of Ultrascale: 1) After
providing the required inputs in xilskey_bbram_ultrascale_input.h, compile the
project. 2) Generate a memory mapped interface file using TCL command
write_mem_info $Outfilename 3) Update memory has to be done using the tcl
command updatemem. updatemem -meminfo $file.mmi -data $Outfilename.elf -bit
$design.bit -proc design_1_i/microblaze_0 -out $Final.bit 4) Program the board
using $Final.bit bitstream 5) Output can be seen in UART terminal. MODIFICATION
HISTORY: Ver Who Date Changes ----- ---- -------- 5.0 vns 09/01/16 First
Release. 6.0 vns 07/28/16 Updated example to allow counting configuration
feature and to program Obfuscated key. 6.7 psl 03/20/19 Added BBRAM key write
support for SSIT devices. psl 03/29/19 Added Support for user configurable GPIO
for jtag control. 6.8 psl 05/21/19 Initialized SystemInitDone ,to indicate
XilSKey_Bbram_JTAGServerInit status. And passed BbramInstancePtr instead of
InstancePtr in XilSKey_Bbram_JTAGServerInit. Include Files /

FILES:
lib/sw_services/xilskey/examples/xilskey_bbram_ultrascale_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilskey_bbram_ultrascale_input.h This file contains macros which needs to
configured by user based on the options selected by user operations will be
performed. @note User configurable parameters for Ultrascale BBRAM define
XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR1_MONO FALSE TRUE will program BBRAM with
OBFUSCATED key provided in XSK_BBRAM_OBFUSCATED_KEY_SLR1. While programming
obfuscated key DPA configurations cannot be done due to silicon bug, and values
provided in DPA configuration macros will be ignored. FALSE will program the
BBRAM with key provided in XSK_BBRAM_AES_KEY_SLR1 and DPA configurations
(protect, count and mode) can be configured define
XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR2 FALSE TRUE will program BBRAM with OBFUSCATED
key provided in XSK_BBRAM_OBFUSCATED_KEY_SLR2. While programming obfuscated key
DPA configurations cannot be done due to silicon bug, and values provided in DPA
configuration macros will be ignored. FALSE will program the BBRAM with key
provided in XSK_BBRAM_AES_KEY_SLR2 and DPA configurations (protect, count and
mode) can be configured define XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR3 FALSE TRUE will
program BBRAM with OBFUSCATED key provided in XSK_BBRAM_OBFUSCATED_KEY_SLR3.
While programming obfuscated key DPA configurations cannot be done due to
silicon bug, and values provided in DPA configuration macros will be ignored.
FALSE will program the BBRAM with key provided in XSK_BBRAM_AES_KEY_SLR3 and DPA
configurations (protect, count and mode) can be configured define
XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR4 FALSE TRUE will program BBRAM with OBFUSCATED
key provided in XSK_BBRAM_OBFUSCATED_KEY_SLR4. While programming obfuscated key
DPA configurations cannot be done due to silicon bug, and values provided in DPA
configuration macros will be ignored. FALSE will program the BBRAM with key
provided in XSK_BBRAM_AES_KEY_SLR4 and DPA configurations (protect, count and
mode) can be configured define XSK_BBRAM_OBFUSCATED_KEY_SLR1
"b1c276899d71fb4cdd4a0a7905ea46c2e11f9574d09c7ea23b70b67de713ccd1" The value
mentioned in this will be converted to hex buffer and the key is programmed into
BBRAM, when program API used. It should be 64 characters long, valid characters
are 0-9,a-f,A-F. Any other character is considered as invalid string and will
not program BBRAM. Note that, for writing the OBFUSCATED Key,
XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR1 should have TRUE value. define
XSK_BBRAM_OBFUSCATED_KEY_SLR2
"b1c276899d71fb4cdd4a0a7905ea46c2e11f9574d09c7ea23b70b67de713ccd1" The value
mentioned in this will be converted to hex buffer and the key is programmed into
BBRAM, when program API used. It should be 64 characters long, valid characters
are 0-9,a-f,A-F. Any other character is considered as invalid string and will
not program BBRAM. Note that, for writing the OBFUSCATED Key,
XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR2 should have TRUE value. define
XSK_BBRAM_OBFUSCATED_KEY_SLR3
"b1c276899d71fb4cdd4a0a7905ea46c2e11f9574d09c7ea23b70b67de713ccd1" The value
mentioned in this will be converted to hex buffer and the key is programmed into
BBRAM, when program API used. It should be 64 characters long, valid characters
are 0-9,a-f,A-F. Any other character is considered as invalid string and will
not program BBRAM. Note that, for writing the OBFUSCATED Key,
XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR3 should have TRUE value. define
XSK_BBRAM_OBFUSCATED_KEY_SLR4
"b1c276899d71fb4cdd4a0a7905ea46c2e11f9574d09c7ea23b70b67de713ccd1" The value
mentioned in this will be converted to hex buffer and the key is programmed into
BBRAM, when program API used. It should be 64 characters long, valid characters
are 0-9,a-f,A-F. Any other character is considered as invalid string and will
not program BBRAM. Note that, for writing the OBFUSCATED Key,
XSK_BBRAM_PGM_OBFUSCATED_KEY_SLR4 should have TRUE value. define
XSK_BBRAM_PGM_AES_KEY_SLR1_OR_MONO FALSE define XSK_BBRAM_PGM_AES_KEY_SLR2 FALSE
define XSK_BBRAM_PGM_AES_KEY_SLR3 FALSE define XSK_BBRAM_PGM_AES_KEY_SLR4 FALSE
TRUE will program BBRAM with AES Key provided in XSK_BBRAM_AES_KEY for
particular SLR. define XSK_BBRAM_AES_KEY_SLR1
"349de4571ae6d88de23de65489acf67000ff5ec901ae3d409aabbce4549812dd" define
XSK_BBRAM_AES_KEY_SLR2
"349de4571ae6d88de23de65489acf67000ff5ec901ae3d409aabbce4549812dd" define
XSK_BBRAM_AES_KEY_SLR3
"349de4571ae6d88de23de65489acf67000ff5ec901ae3d409aabbce4549812dd" define
XSK_BBRAM_AES_KEY_SLR4
"349de4571ae6d88de23de65489acf67000ff5ec901ae3d409aabbce4549812dd" The value
mentioned in this will be converted to hex buffer and the key is programmed into
BBRAM for particular SLR(1/2/3/4), when program API used. It should be 64
characters long, valid characters are 0-9,a-f,A-F. Any other character is
considered as invalid string and will not program BBRAM. Note that, for writing
the BBRAM Key, XSK_ BBRAM_PGM_OBFUSCATED_KEY for particular SLR(1/2/3/4)should
have FALSE value. define XSK_BBRAM_AES_KEY_SIZE_IN_BITS 256 define
XSK_BBRAM_DPA_PROTECT_ENABLE FALSE TRUE will enable the DPA protection for BBRAM
key, to enable DPA protection XSK_BBRAM_PGM_OBFUSCATED_KEY should be FALSE, as
DPA protection is not supported for Obfuscated key due to silicon bug,
XSK_BBRAM_DPA_COUNT should be in the range of 1-255 and XSK_BBRAM_DPA_MODE can
be XSK_BBRAM_INVALID_CONFIGURATIONS or XSK_BBRAM_ALL_CONFIGURATIONS. FALSE will
not enable DPA protection, XSK_BBRAM_DPA_COUNT and XSK_BBRAM_DPA_MODE both will
be taken default values 0 and XSK_BBRAM_INVALID_CONFIGURATIONS respectively
define XSK_BBRAM_DPA_COUNT 0 Default value will be zero, when
XSK_BBRAM_DPA_PROTECT_ENABLE is TRUE this should be in range of 1-255 (should be
greater that zero). define XSK_BBRAM_DPA_MODE XSK_BBRAM_INVALID_CONFIGURATIONS
Default value is XSK_BBRAM_INVALID_CONFIGURATIONS When
XSK_BBRAM_DPA_PROTECT_ENABLE is TRUE it can be XSK_BBRAM_INVALID_CONFIGURATIONS
or XSK_BBRAM_ALL_CONFIGURATIONS If XSK_BBRAM_DPA_PROTECT_ENABLE is FALSE, it
should be XSK_BBRAM_INVALID_CONFIGURATIONS. define XSK_BBRAM_AXI_GPIO_DEVICE_ID
XPAR_AXI_GPIO_0_DEVICE_ID Default value is XPAR_AXI_GPIO_0_DEVICE_ID This macro
is for providing exact GPIO device ID, based on the design configuration this
macro should be modified to provide GPIO device ID which is used for connecting
MASTER JTAG pins. In Ultrascale GPIO pins are used for connecting MASTER_JTAG
pins to access BBRAM. Following are the GPIO pins and user can change these pins
define XSK_BBRAM_AXI_GPIO_JTAG_TDO (0) define XSK_BBRAM_AXI_GPIO_JTAG_TDI (0)
define XSK_BBRAM_AXI_GPIO_JTAG_TMS (1) define XSK_BBRAM_AXI_GPIO_JTAG_TCK (2)
define XSK_BBRAM_GPIO_INPUT_CH (2) This macro is for providing channel number of
ALL INPUTS connected(TDO) define XSK_BBRAM_GPIO_OUTPUT_CH (1) This macro is for
providing channel number of ALL OUTPUTS connected (TDI, TCK, TMS) NOTE: All
inputs and outputs of GPIO can be configured in single channel also i.e
XSK_BBRAM_GPIO_INPUT_CH XSK_BBRAM_GPIO_OUTPUT_CH 1 or 2. Among (TDI, TCK, TMS)
Outputs of GPIO cannot be connected to different GPIO channels all the 3 signals
should be in same channel. TDO can be a other channel of (TDI, TCK, TMS) or the
same. DPA protection can be enabled only when programming non-obfuscated key.
<pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 5.0 vns
09/01/16 First Release. 6.0 vns 07/28/16 Added counting configuration
feature(DPA count), protection and to program Obfuscated key. 6.7 psl 03/20/19
Added BBRAM key write support for SSIT devices. psl 03/29/19 Added Support for
user configurable GPIO for jtag control. </pre>

FILES:
lib/sw_services/xilskey/examples/xilskey_bbram_ultrascale_input.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilskey_bbramps_zynqmp_example.c This file illustrates how to program AES key of
ZynqMP BBRAM. Ideally example should be excited with status 0x00000000 if not
there was some error in programming. @note: No need to include any header file
in src of the application. <pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ------ -------- 4.0 vns 10/08/15 First release 6.7 psl 04/10/19 Fixed IAR
warnings. </pre> Include Files /

FILES:
lib/sw_services/xilskey/examples/xilskey_bbramps_zynqmp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_efuse_example.c @note
Contains the api functions for the PS & PL eFUSE functionality. eFUSE
Application project is capable of programming the PS and PL eFUSE bits given by
the user. PS eFUSE holds the RSA primary key hash bits and user feature bits,
which will enable/disable some features in ZYNQ. In Zynq PL eFUSE holds the AES
key, user key and some feature bits and and in Ultrascale eFUSE holds AES key,
User key, RSA key Hash and some feature bits. User has the provision to write PS
eFUSE & PL eFUSE independently or can combine together. This can be selected by
using the compilation switch provided in xilskey_input.h. XSK_EFUSEPS_DRIVER
should be defined to enable PS functionality & XSK_EFUSEPL_DRIVER for PL
functionality. However for programming eFuse Ultrascale only XSK_EFUSEPL_DRIVER
should be enabled. eFUSE bits are one-time programmable. Once they are burnt,
they cannot be changed. Make sure you enter the correct information before you
program eFUSE bits. POR reset is required for the eFUSE values to become into
effect. Please do a POR reset after eFUSE writing. All the user configurable
parameters for PS & PL eFUSE writing should be defined in xilskey_input.h. By
default, all the macros will be defined with FALSE values. For Zynq For PL eFUSE
writing enabling the caches are necessary if the image is executing from DDR.
This will be done in BSP by default. User has to take care not to disable
caches. eFUSE writing procedure running out of DDR as an application: (This
sequence is same as the existing flow described below) 1) After providing the
required inputs in xilskey_input.h, compile the project. 2) Take the latest FSBL
(.elf) and stitch the <output>.elf generated to it using the bootgen utility and
generate a bootable image. 3) Write the generated binary image into the flash
device. (Ex: QSPI,NAND etc) 4) Execute image from flash which will write the
mentioned eFUSE key bits. eFUSE driver compilation procedure for OCM: 1) Open
the linker script (lscript.ld) in the SDK project. 2) Now map all the sections
points to ps7_ram_0_S_AXI_BASEADDR instead of ps7_ddr_0_S_AXI_BASEADDR.
Example: Click on the Memory Region tab for .text section & select
ps7_ram_0_S_AXI_BASEADDR from the drop down list. 3) Copy the ps7_init.c &
ps7_init.h files from the hw_platform folder into the example folder. 4)
Uncomment calling of ps7_init() routine in xilskey_efuse_example.c 5)
Compile the project. 6) <project name>.elf will be generated. This will be
executed out of OCM. For Ultrascale Accessing Ultrascale microblaze 's eFuse is
done by using block RAM initialization. Ultrascale eFUSE programming is done
through MASTER JTAG. Crucial Programming sequence will be taken care by Hardware
module. So Hardware module should be added compulsory in the design. Please use
hardware module's vhd code and instructions provided to add Hardware module in
the design. Software will handover jtag navigation to Hardware module before
entering JTAG IDLE state, by setting START pin of Hardware module to high and
once programming of specified bit is done Hardware module will set END pin to
high. Master Jtag primitive has to added to design i.e MASTER_JTAG_inst
instantiation have to performed and AXI GPIO pins has to be connected to TDO,
TDI, TMS and TCK signals of MASTER_JTAG primitive. Hardware module has to be
added to our design and respective pins of the hardware module needs to be
connected to AXI GPIO pins. Hardware module has three signals READY, START and
END. All Inputs(TDO, READY and END) and All Outputs(TDI, TMS, TCK, START) of
Hardware module, MASTER_JTAG can be connected as follows. 1) All Inputs to one
channel All Outputs to other channel Valid example: All Outputs connected to
Channel 1 Input signal TDO also connected to channel 2 2) All Inputs and All
Outputs to same channel. Valid example: All Outputs connected to Channel 1 Input
signal TDO also connected to channel 1 3) But some of the Outputs in one channel
and some of them in different channel is not accepted. Invalid example: All
Outputs connected to Channel 1 Input signals (TDI, TMS) connected to Channel 1
Input signal TCK also connected to channel 2 The design should only contain AXI
bram Ctrl memory mapped(1MB). System management wizard should be operated in DRP
interface. Note: MASTER_JTAG will disable all other JTAGs Procedure to access
efuse of Ultrascale: 1) After providing the required inputs in xilskey_input.h,
compile the project. 2) Generate a memory mapped interface(mmi) file using TCL
command write_mem_info $Outfilename 3) Create an associate elf file. (OR) Update
memory has to be done using the tcl command updatemem. updatemem -meminfo
$file.mmi -data $Outfilename.elf -bit $design.bit -proc design_1_i/microblaze_0
-out $Final.bit 4) Program the board using $Final.bit bitstream 5) Output can be
seen in UART terminal. 6) For calculating CRC of AES key reverse polynomial is
0x82F63B78 or one can use the API u32 XilSKey_CrcCalculation(u8 Key)
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpoolla
04/26/13 First release 1.02a hk 10/28/13 Added use of API's read status and key.
PR 735957. 3.00 vns 31/07/15 Modified XSK_EFUSEPL_RSA_KEY_HASH_STRING_SIZE macro
name to XSK_EFUSEPS_RSA_KEY_HASH_STRING_SIZE. Added missing goto statement.
Modified init function, intialisation of instance is done based on the platform
and Modified example to support both Zynq PL's eFuse and also Ultrascale's
eFuse. 4.00 vns 09/10/15 Added DFT JTAG disable and DFT MODE disable programming
and reading options for Zynq eFuse PS. 6.0 vns 07/07/16 Added Gpio pin numbers
connected to hardware module. 6.4 vns 02/27/18 Added support for programming
secure bit 6 enable obfuscation feature for eFUSE AES key 03/09/17 Corrected
status bits of Ultrascale plus 6.7 arc 10/29/18 Fixed ARMCC compiler warnings
and errors psl 03/20/19 Added eFuse key write support for SSIT devices. psl
03/29/19 Added support for user configurable GPIO for jtag control. psl 04/29/19
Resolved GCC warnings. 6.8 psl 05/21/19 Added platform dependent macros for
variables and initialized PlStatus. Added print for current SLR and CRC.
07/17/19 Added print to display CRC of AES key during CRC verification. Include
Files /

FILES:
lib/sw_services/xilskey/examples/xilskey_efuse_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file
xilskey_efuseps_zynqmp_example.c This file illustrates how to program ZynqMp
efuse and read back the keys from efuse. <pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ------ -------- 4.0 vns 10/01/15 First release vns 10/20/15
Modified XilSKey_EfusePs_Example_ReadSecCtrlBits API while reading RSA
authentication and PPK revokes bits status it may return 0 or BOTH_BITS_SET. So
in place of TRUE added BOTH_BITS_SET. 6.0 vns 07/18/16 Removed JTAG user code
programming and reading feature as it is not the part of the eFUSE 3.0 silicon.
Modified XilSKey_ZynqMp_EfusePs_ReadUserKey function to
XilSKey_ZynqMp_EfusePs_ReadUserFuse. Provided single bit programming facility
for User FUSES. Modified RSA authentication bit set macro BOTH_BITS_SET to
XSK_ZYNQMP_SEC_RSA_15BITS_SET and XSK_ZYNQMP_SEC_RSA_3BITS_SET, from silicon
version 3.0 RSA authentication is possible only if all 15 bits of RSA
authentication bits are set, for 1.0 and 2.0 versions only 2 bits are needed,
for PPK0 REVOKE check added new macro XSK_ZYNQMP_SEC_PPK_INVLD_BITS_SET 6.2 vns
03/10/17 Added support for programming and reading LDP SC EN, FPD SC EN, LBIST,
reading some of reserved bits, modified names of secure control bits Provided
DNA read API call in example. 6.4 vns 02/19/18 Removed
XilSKey_ZynqMp_EfusePs_CacheLoad() call as now library is been updated to reload
cache after successful programming of the requested efuse bits. 6.7 psl 03/13/19
Added XSK_EFUSEPS_CHECK_AES_KEY_CRC, to check for AES key CRC if TRUE. psl
03/28/19 Corrected typos psl 04/10/19 Fixed IAR warnings. 6.8 psl 07/17/19 Added
print to display CRC of AES key for CRC verification. </pre> Include Files /

FILES:
lib/sw_services/xilskey/examples/xilskey_efuseps_zynqmp_example.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_efuseps_zynqmp_input.h.
This file contains macros which needs to configured by user based on the options
selected by user operations will be performed. @note User configurable
parameters for ZynqMP PS eFUSE define XSK_EFUSEPS_AES_RD_LOCK FALSE TRUE
permanently disables the CRC check of FUSE_AES. FALSE will not modify this
control bit of eFuse. define XSK_EFUSEPS_AES_WR_LOCK FALSE TRUE permanently
disables the writing to FUSE_AES block. FALSE will not modify this control bit
of eFuse. define XSK_EFUSEPS_ENC_ONLY FALSE TRUE permanently enables encrypted
booting only using the Fuse key. It forces to use AES key from eFUSE. FALSE will
not modify this control bit of eFuse. define XSK_EFUSEPS_BBRAM_DISABLE FALSE
TRUE permanently disables the BBRAM key. FALSE will not modify this control bit
of eFuse. define XSK_EFUSEPS_ERR_DISABLE FALSE TRUE permanently disables the
error messages in the JTAG status register. FALSE will not modify this control
bit of eFuse. define XSK_EFUSEPS_JTAG_DISABLE FALSE TRUE permanently disables
the JTAG controller. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_DFT_DISABLE FALSE TRUE permanently disables DFT boot mode. FALSE
will not modify this control bit of eFuse. define XSK_EFUSEPS_PROG_GATE_DISABLE
FALSE TRUE permanently disables the PROG_GATE feature in PPD. If you set this
then the PROG_GATE can never be activated and the PL will always be reset when
the PS goes down. Also prevents reboot into JTAG mode after a secure lock down.
FALSE will not modify this control bit of eFuse. define XSK_EFUSEPS_SECURE_LOCK
FALSE TRUE permanently disables reboot into JTAG mode when performing a secure
lockdown. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_RSA_ENABLE FALSE TRUE permanently enables RSA authentication during
boot. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_PPK0_WR_LOCK FALSE TRUE permanently disables writing to PPK0 eFUSEs.
FALSE will not modify this control bit of eFuse. define XSK_EFUSEPS_PPK0_INVLD
FALSE TRUE permanently revokes PPK0. FALSE will not modify this control bit of
eFuse. define XSK_EFUSEPS_PPK1_WR_LOCK FALSE TRUE permanently disables writing
to PPK1 eFUSEs. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_PPK1_INVLD FALSE TRUE permanently revokes PPK1. FALSE will not
modify this control bit of eFuse. define XSK_EFUSEPS_LBIST_EN FALSE TRUE
permanently enables logic BIST to be run during boot. FALSE will not modify this
control bit of eFUSE. define XSK_EFUSEPS_LPD_SC_EN FALSE TRUE permanently
enables zeroization of registers in Low Power Domain(LPD) during boot. FALSE
will not modify this control bit of eFUSE. define XSK_EFUSEPS_FPD_SC_EN FALSE
TRUE permanently enables zeroization of registers in the Full Power Domain(FPD)
during boot. FALSE will not modify this control bit of eFUSE. define
XSK_EFUSEPS_PBR_BOOT_ERR FALSE TRUE forces the boot to halt when there is any
error detected in the PMU. FALSE will not modify this control bit of eFUSE.
define XSK_EFUSEPS_USER_WRLK_0 FALSE TRUE permanently disables writing to USER_0
efuses. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_USER_WRLK_1 FALSE TRUE permanently disables writing to USER_1
efuses. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_USER_WRLK_2 FALSE TRUE permanently disables writing to USER_2
efuses. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_USER_WRLK_3 FALSE TRUE permanently disables writing to USER_3
efuses. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_USER_WRLK_4 FALSE TRUE permanently disables writing to USER_4
efuses. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_USER_WRLK_5 FALSE TRUE permanently disables writing to USER_5
efuses. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_USER_WRLK_6 FALSE TRUE permanently disables writing to USER_6
efuses. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPS_USER_WRLK_7 FALSE TRUE permanently disables writing to USER_7
efuses. FALSE will not modify this control bit of eFuse. Following has to be set
for programming required keys define XSK_EFUSEPS_WRITE_AES_KEY FALSE TRUE will
burn the AES key provided in XSK_EFUSEPS_AES_KEY. FALSE will ignore the key
provided in XSK_EFUSEPS_AES_KEY. define XSK_EFUSEPS_WRITE_PPK0_SHA3_HASH FALSE
TRUE will burn PPK0 with it's SHA3 hash provided in XSK_EFUSEPS_PPK0_SHA3_HASH.
FALSE will ignore the hash provided in XSK_EFUSEPS_PPK0_SHA3_HASH. define
XSK_EFUSEPS_WRITE_PPK1_SHA3_HASH FALSE TRUE will burn PPK1 with it's SHA3 hash
provided in XSK_EFUSEPS_PPK1_SHA3_HASH. FALSE will ignore the hash provided in
XSK_EFUSEPS_PPK1_SHA3_HASH. define XSK_EFUSEPS_WRITE_SPKID FALSE TRUE will burn
SPKID provided in XSK_EFUSEPS_SPK_ID. FALSE will ignore the hash provided in
XSK_EFUSEPS_SPK_ID. define XSK_EFUSEPS_WRITE_USER0_FUSE FALSE TRUE will burn
User0 Fuse provided in XSK_EFUSEPS_USER0_FUSES. FALSE will ignore the value
provided in XSK_EFUSEPS_USER0_FUSES define XSK_EFUSEPS_WRITE_USER1_FUSE FALSE
TRUE will burn User1 Fuse provided in XSK_EFUSEPS_USER1_FUSES. FALSE will ignore
the value provided in XSK_EFUSEPS_USER1_FUSES define
XSK_EFUSEPS_WRITE_USER2_FUSE FALSE TRUE will burn User2 Fuse provided in
XSK_EFUSEPS_USER2_FUSES. FALSE will ignore the value provided in
XSK_EFUSEPS_USER2_FUSES define XSK_EFUSEPS_WRITE_USER3_FUSE FALSE TRUE will burn
User3 Fuse provided in XSK_EFUSEPS_USER3_FUSES. FALSE will ignore the value
provided in XSK_EFUSEPS_USER3_FUSES define XSK_EFUSEPS_WRITE_USER4_FUSE FALSE
TRUE will burn User4 Fuse provided in XSK_EFUSEPS_USER4_FUSES. FALSE will ignore
the value provided in XSK_EFUSEPS_USER4_FUSES define
XSK_EFUSEPS_WRITE_USER5_FUSE FALSE TRUE will burn User5 Fuse provided in
XSK_EFUSEPS_USER5_FUSES. FALSE will ignore the value provided in
XSK_EFUSEPS_USER5_FUSES define XSK_EFUSEPS_WRITE_USER6_FUSE FALSE TRUE will burn
User6 Fuse provided in XSK_EFUSEPS_USER6_FUSES. FALSE will ignore the value
provided in XSK_EFUSEPS_USER6_FUSES define XSK_EFUSEPS_WRITE_USER7_FUSE FALSE
TRUE will burn User7 Fuse provided in XSK_EFUSEPS_USER7_FUSES. FALSE will ignore
the value provided in XSK_EFUSEPS_USER7_FUSES define XSK_EFUSEPS_AES_KEY
"0000000000000000000000000000000000000000000000000000000000000000" The value
mentioned in this will be converted to hex buffer and written into the ZynqMP Ps
eFUSE array when write API used. This value should be given in string format. It
should be 64 characters long, valid characters are 0-9,a-f,A-F. Any other
character is considered as invalid string and will not burn any Fuses. Note
that,for writing the AES Key, XSK_EFUSEPS_WRITE_AES_KEY should be set to TRUE.
NOTE: This AES key is only red key or gray key. To program black key to eFuse,
please use xilskey_puf_registeration application and refer define
XSK_EFUSEPS_PPK0_IS_SHA3 TRUE Default value is TRUE. TRUE
XSK_EFUSEPS_PPK0_SHA3_HASH should be of string length 96 it specifies that PPK0
is used to program SHA3 hash. define XSK_EFUSEPS_PPK0_HASH "00000000000000000000
000000000000000000000000000000000000000000000000000000000000000000000000000" The
value will be converted to a hex buffer and will be written into the ZynqMP Ps
eFUSE array. This value should be given in string format. It should be 96 or 64
characters long, valid characters are 0-9,a-f,A-F. Any other character is
considered invalid and will not burn PPK0 hash. Note that,for writing the PPK0
hash, XSK_EFUSEPS_WRITE_PPK0_SHA3_HASH should be set to TRUE. While writing SHA3
hash, length should be 96 characters long and XSK_EFUSEPS_PPK0_IS_SHA3 macro
should be set to TRUE define XSK_EFUSEPS_PPK1_IS_SHA3 TRUE Default value is
TRUE. TRUE XSK_EFUSEPS_PPK1_SHA3_HASH should be of string length 96 it specifies
that PPK1 is used to program SHA3 hash. define XSK_EFUSEPS_PPK1_HASH
"0000000000000000000000000000000000000000000000000000000000000000" The value
will be converted to a hex buffer and will be written into the ZynqMP Ps eFUSE
array. This value should be given in string format. It should be 96 or 64
characters long, valid characters are 0-9,a-f,A-F. Any other character is
considered invalid and will not burn PPK0 hash. Note that,for writing the PPK1
hash, XSK_EFUSEPS_WRITE_PPK1_SHA3_HASH should be set to TRUE. While writing SHA3
hash, length should be 96 characters long and XSK_EFUSEPS_PPK1_IS_SHA3 macro
should be set to TRUE define XSK_EFUSEPS_SPK_ID "00000000" The value will be
converted to a hex buffer and written into the ZynqMP Ps eFUSE array when write
API used. This value should be given in string format. It should be 8 characters
long, valid characters are 0-9,a-f,A-F. Any other character is considered as
invalid string and will not burn SPK ID. Note that,for writing the SPK ID,
XSK_EFUSEPS_WRITE_SPKID should be set to TRUE. define XSK_EFUSEPS_USER0_FUSES
"00000000" The value will be converted to hex buffer and written into the ZynqMP
Ps eFUSE array when write API used. This value should be given in string format.
It should be 8 characters long, valid characters are 0-9,a-f,A-F. Any other
character is considered as invalid string and will not burn User Fuse. Note
that,for writing the User0 Fuse, XSK_EFUSEPS_WRITE_USER0_FUSE should be set to
TRUE. define XSK_EFUSEPS_USER1_FUSES "00000000" The value will be converted to
hex buffer and written into the ZynqMP Ps eFUSE array when write API used. This
value should be given in string format. It should be 8 characters long, valid
characters are 0-9,a-f,A-F. Any other character is considered as invalid string
and will not burn User Fuse. Note that,for writing the User1 Fuse,
XSK_EFUSEPS_WRITE_USER1_FUSE should be set to TRUE. define
XSK_EFUSEPS_USER2_FUSES "00000000" The value will be converted to hex buffer and
written into the ZynqMP Ps eFUSE array when write API used. This value should be
given in string format. It should be 8 characters long, valid characters are
0-9,a-f,A-F. Any other character is considered as invalid string and will not
burn User Fuse. Note that,for writing the User2 Fuse,
XSK_EFUSEPS_WRITE_USER2_FUSE should be set to TRUE. define
XSK_EFUSEPS_USER3_FUSES "00000000" The value will be converted to hex buffer and
written into the ZynqMP Ps eFUSE array when write API used. This value should be
given in string format. It should be 8 characters long, valid characters are
0-9,a-f,A-F. Any other character is considered as invalid string and will not
burn User Fuse. Note that,for writing the User3 Fuse,
XSK_EFUSEPS_WRITE_USER3_FUSE should be set to TRUE. define
XSK_EFUSEPS_USER4_FUSES "00000000" The value will be converted to hex buffer and
written into the ZynqMP Ps eFUSE array when write API used. This value should be
given in string format. It should be 8 characters long, valid characters are
0-9,a-f,A-F. Any other character is considered as invalid string and will not
burn User Fuse. Note that,for writing the User4 Fuse,
XSK_EFUSEPS_WRITE_USER4_FUSE should be set to TRUE. define
XSK_EFUSEPS_USER5_FUSES "00000000" The value will be converted to hex buffer and
written into the ZynqMP Ps eFUSE array when write API used. This value should be
given in string format. It should be 8 characters long, valid characters are
0-9,a-f,A-F. Any other character is considered as invalid string and will not
burn User Fuse. Note that,for writing the User5 Fuse,
XSK_EFUSEPS_WRITE_USER5_FUSE should be set to TRUE. define
XSK_EFUSEPS_USER6_FUSES "00000000" The value will be converted to hex buffer and
written into the ZynqMP Ps eFUSE array when write API used. This value should be
given in string format. It should be 8 characters long, valid characters are
0-9,a-f,A-F. Any other character is considered as invalid string and will not
burn User Fuse. Note that,for writing the User6 Fuse,
XSK_EFUSEPS_WRITE_USER6_FUSE should be set to TRUE. define
XSK_EFUSEPS_USER7_FUSES "00000000" The value will be converted to hex buffer and
written into the ZynqMP Ps eFUSE array when write API used. This value should be
given in string format. It should be 8 characters long, valid characters are
0-9,a-f,A-F. Any other character is considered as invalid string and will not
burn User Fuse. Note that,for writing the User7 Fuse,
XSK_EFUSEPS_WRITE_USER7_FUSE should be set to TRUE. define
XSK_EFUSEPS_CHECK_AES_KEY_CRC FALSE Default value is FALSE TRUE will check the
CRC provided in XSK_EFUSEPS_AES_KEY. CRC verification is done after programming
AES key to verify the key is programmed properly or not, if not library error
outs the same. So While programming AES key it is not necessary to verify the
AES key again. NOTE: Please make sure if intention is to check only CRC of the
provided key and not programming AES key then do not modify
XSK_EFUSEPS_WRITE_AES_KEY (TRUE will Program key). NOTE: The PPK hash should be
the unmodified hash generated by bootgen. Single bit programming is allowed for
User FUSEs (0 through 7), however if the user specifies a value that tries to
set a bit that was previously programmed to 1 back to 0, throws an error. Even
if the bits are already programmed user must pass these already programmed bits
along with the new bits that need to be programmed. <pre> MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- 4.0 vns 10/01/15 First release 6.0
vns 07/18/16 Removed JTAG user code programming and reading feature. Modified
User FUSE programming, such that library accepts separate requests for
programming and reading USER FUSES(0 to 7). Provided single bit programming
feature for USER FUSEs. 6.2 vns 03/10/17 Modified
XSK_EFUSEPs_FORCE_USE_AES_ONLY-> XSK_EFUSEPS_ENC_ONLY,
XSK_EFUSEPS_ERR_OUTOF_PMU_DISABLE -> XSK_EFUSEPS_ERR_DISABLE,
XSK_EFUSEPS_PPK0_REVOKE->XSK_EFUSEPS_PPK0_INVLD
XSK_EFUSEPS_PPK1_REVOKE->XSK_EFUSEPS_PPK1_INVLD Added support for programming
LBIST, LPD and FPD SC enable bits by providing corresponding macros Removed 3
macros for PROG GATE disable, now it can programmed by setting only one macro.
6.7 psl 03/13/19 Added XSK_EFUSEPS_CHECK_AES_KEY_CRC, to check for AES key CRC
if TRUE. psl 03/28/19 Updated Description for XSK_EFUSEPS_CHECK_AES_KEY_CRC 6.8
psl 06/07/19 Added doxygen tags. </pre>

FILES:
lib/sw_services/xilskey/examples/xilskey_efuseps_zynqmp_input.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_input.h @note User
configurable parameters for PS eFUSE define XSK_EFUSEPS_ENABLE_WRITE_PROTECT
FALSE TRUE to burn the write protect bits in eFUSE array. Write protect has two
bits, when any of the bit is blown, it is considered as write protected. So,
while burning the Write protect bits, even if one bit is blown, write API
returns success. Note that, POR reset is required after burning, for write
protection of the eFUSE bits to come into effect. It is recommended to do the
POR reset after write protection. Also note that, once write protect bits are
burned, no more eFUSE writes are possible. So, please be sure when burning the
write protect bits. If the Write protect macro is TRUE with other macros, write
protect will be burned in the last, after burning all the defined values, so
that for any error while burning other macros will not effect the total eFUSE
array. FALSE will not modify the write protect bits. define
XSK_EFUSEPS_ENABLE_RSA_AUTH FALSE TRUE to burn the RSA enable bit in PS eFUSE
array. After enabling the bit, every successive boot must be RSA enabled apart
from JTAG. Before burning this bit, make sure that eFUSE array has the valid PPK
hash.If the PPK hash burning is enabled, only after writing the hash
successfully, RSA enable bit will be blown. Note that, for RSA enable bit to
take effect, POR reset is required. FALSE will not modify the RSA enable bit.
define XSK_EFUSEPS_ENABLE_ROM_128K_CRC FALSE TRUE will burn the ROM 128k crc
bit. Every successive boot after this, BootROM will calculate 128k crc. FALSE
will not modify the ROM CRC128K bit. define XSK_EFUSEPS_DISABLE_DFT_JTAG FALSE
TRUE will disable DFT JTAG permanently. FALSE will not modify the eFuse PS DFT
JTAG disable bit define XSK_EFUSEPS_DISABLE_DFT_MODE FALSE TRUE will disable DFT
mode permanently. FALSE will not modify the eFuse PS DFT mode disable bit define
XSK_EFUSEPS_ENABLE_RSA_KEY_HASH FALSE TRUE will burn the eFUSE hash, that is
given in XSK_EFUSEPS_RSA_KEY_HASH_VALUE when write API is used. TRUE will read
the eFUSE hash when read API is used and will be read into structure. FALSE will
ignore the value given. define XSK_EFUSEPS_RSA_KEY_HASH_VALUE
"c8bb4d9e1fcdbd27b99d48a3df5720b98f35bafabb1e10333a78322fb82ce63d" The value
mentioned in this will be converted to hex buffer and written into the PS eFUSE
array when write API used. This value should be the PPK(Primary Public Key) hash
given in string format. It should be 64 characters long, valid characters are
0-9,a-f,A-F. Any other character is considered as invalid string and will not
burn RSA hash. Note: When XilSKey_EfusePs_Write() API is used, above mentioned
RSA hash is written and XSK_EFUSEPS_ENABLE_RSA_KEY_HASH should have TRUE value.
User configurable parameters for PL eFUSE for Zynq define
XSK_EFUSEPL_FORCE_PCYCLE_RECONFIG FALSE TRUE then part has to be power cycled to
be able to be reconfigured. FALSE will not set the eFUSE control bit. define
XSK_EFUSEPL_DISABLE_KEY_WRITE FALSE TRUE will disable eFUSE write to FUSE_AES
and FUSE_USER blocks XFLASE will enable eFUSE write to FUSE_AES and FUSE_USER
blocks define XSK_EFUSEPL_DISABLE_AES_KEY_READ FALSE TRUE will disable the write
to FUSE_AES & FUSE_USER key & disables read of FUSE_AES. FALSE will enable eFUSE
read from & write to FUSE_AES and FUSE_USER blocks define
XSK_EFUSEPL_DISABLE_USER_KEY_READ FALSE TRUE will disable the write to FUSE_AES
& FUSE_USER key & disables read of FUSE_USER FALSE will enable eFUSE read from &
write to FUSE_AES and FUSE_USER blocks Note: If any one of the above two
definitions are FALSE then reading of FUSE_AES & FUSE_USER is not possible
define XSK_EFUSEPL_DISABLE_FUSE_CNTRL_WRITE FALSE TRUE will disable the eFUSE
write to FUSE_CTRL block FALSE will not set the eFUSE control bit, so that user
can write into FUSE_CTRL block later. define XSK_EFUSEPL_FORCE_USE_AES_ONLY
FALSE TRUE will force to use secure boot with eFUSE AES key only FALSE will not
set the eFUSE control bit so that user can use non-secure boot. define
XSK_EFUSEPL_DISABLE_JTAG_CHAIN FALSE If TRUE then permanently sets the Zynq ARM
DAP controller in bypass mode. FALSE will allow Zynq ARM DAP visible through
JTAG. define XSK_EFUSEPL_BBRAM_KEY_DISABLE FALSE TRUE will force eFUSE key to be
used if booting Secure Image. FALSE will not set the eFUSE control bit so that
user can use secure boot with BBRAM key. Following are the MIO pins used for PL
JTAG operations. User can change these pins as their discretion. define
XSK_EFUSEPL_MIO_JTAG_TDI (17) define XSK_EFUSEPL_MIO_JTAG_TDO (21) define
XSK_EFUSEPL_MIO_JTAG_TCK (19) define XSK_EFUSEPL_MIO_JTAG_TMS (20) MUX selection
pin: define XSK_EFUSEPL_MIO_JTAG_MUX_SELECT (11) This pin is used to select
between the external JTAG or MIO driving JTAG operations. define
XSK_EFUSEPL_MIO_MUX_SEL_DEFAULT_VAL LOW LOW writes zero on the mux select line
before writing the PL eFUSE HIGH writes one on the mux select line before
writing the PL eFUSE define XSK_EFUSEPL_PROGRAM_AES_AND_USER_LOW_KEY FALSE TRUE
will burn the AES & User Low hash key, that is given in XSK_EFUSEPL_AES_KEY &
XSK_EFUSEPL_USER_LOW_KEY respectively. FALSE will ignore the values given. Note:
User cannot write AES Key & User Low Key separately. define
XSK_EFUSEPL_PROGRAM_USER_HIGH_KEY FALSE TRUE will burn the User High hash key,
that is given in XSK_EFUSEPL_AES_KEY & XSK_EFUSEPL_USER_LOW_KEY respectively.
FALSE will ignore the values given. define XSK_EFUSEPL_AES_KEY
"0000000000000000000000000000000000000000000000000000000000000000" The value
mentioned in this will be converted to hex buffer and written into the PL eFUSE
array when write API used. This value should be the AES key given in string
format. It should be 64 characters long, valid characters are 0-9,a-f,A-F. Any
other character is considered as invalid string and will not burn AES Key. Note
that, for writing the AES Key, XSK_EFUSEPL_PROGRAM_AES_AND_USER_LOW_KEY should
have TRUE value. define XSK_EFUSEPL_USER_LOW_KEY "00" The value mentioned in
this will be converted to hex buffer and written into the PL eFUSE array when
write API used. This value should be the User Low Key given in string format. It
should be 2 characters long, valid characters are 0-9,a-f,A-F. Any other
character is considered as invalid string and will not burn User Low Key. Note
that, for writing the AES Key, XSK_EFUSEPL_PROGRAM_AES_AND_USER_LOW_KEY should
have TRUE value. define XSK_EFUSEPL_USER_HIGH_KEY "000000" The value mentioned
in this will be converted to hex buffer and written into the PL eFUSE array when
write API used. This value should be the User High Key given in string format.
It should be 6 characters long, valid characters are 0-9,a-f,A-F. Any other
character is considered as invalid string and will not burn User High Key. Note
that, for writing the AES Key, XSK_EFUSEPL_PROGRAM_USER_HIGH_KEY should have
TRUE value. BBRAM related definitions: MIO pins used for JTAG signals. Can be
changed as per hardware. define XSK_BBRAM_MIO_JTAG_TDI (17) define
XSK_BBRAM_MIO_JTAG_TDO (21) define XSK_BBRAM_MIO_JTAG_TCK (19) define
XSK_BBRAM_MIO_JTAG_TMS (20) define XSK_BBRAM_MIO_JTAG_MUX_SELECT (11) define
XSK_BBRAM_MIO_MUX_SEL_DEFAULT_VAL LOW Default value to enable the PL JTAG This
is the 256 bit key to be programmed into BBRAM. This should entered by user in
HEX. define XSK_BBRAM_AES_KEY
"349de4571ae6d88de23de65489acf67000ff5ec901ae3d409aabbce4549812dd" define
XSK_BBRAM_AES_KEY_SIZE_IN_BITS 256 User configurable parameters for PL eFUSE for
Kintex Ultrascale define XSK_EFUSEPL_PGM_SLR1 FALSE define XSK_EFUSEPL_PGM_SLR2
FALSE define XSK_EFUSEPL_PGM_SLR3 FALSE define XSK_EFUSEPL_PGM_SLR4 FALSE TRUE
will select particular SLR(1/2/3/4) to program: - AES Keys(256bits/SLR) - User
Fuse bits (32bits/SLR) - User Keys (128bits/SLR) - RSA Public Key HASH
(384bits/SLR) FALSE will disable programming. define
XSK_EFUSEPL_DISABLE_AES_KEY_READ FALSE TRUE will permanently disables the write
to FUSE_AES and check CRC for AES key by programming control bit of FUSE. FALSE
will not modify this control bit of eFuse. define
XSK_EFUSEPL_DISABLE_USER_KEY_READ FALSE TRUE will permanently disables the write
to 32 bit FUSE_USER and read of FUSE_USER key by programming control bit of
FUSE. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPL_DISABLE_SECURE_READ FALSE TRUE will permanently disables the write
to FUSE_Secure block and reading of secure block by programming control bit of
FUSE. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPL_DISABLE_FUSE_CNTRL_WRITE FALSE TRUE will permanently disables the
write to FUSE_CNTRL block by programming control bit of FUSE. FALSE will not
modify this control bit of eFuse. define XSK_EFUSEPL_DISABLE_RSA_KEY_READ FALSE
TRUE will permanently disables the write to FUSE_RSA block and reading of
FUSE_RSA Hash by programming control bit of FUSE. FALSE will not modify this
control bit of eFuse. define XSK_EFUSEPL_DISABLE_KEY_WRITE FALSE TRUE will
permanently disables the write to FUSE_AES block by programming control bit of
FUSE. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPL_DISABLE_USER_KEY_WRITE FALSE TRUE will permanently disables the
write to FUSE_USER block by programming control bit of FUSE. FALSE will not
modify this control bit of eFuse. define XSK_EFUSEPL_DISABLE_SECURE_WRITE FALSE
TRUE will permanently disables the write to FUSE_SECURE block by programming
control bit of FUSE. FALSE will not modify this control bit of eFuse. define
XSK_EFUSEPL_DISABLE_RSA_HASH_WRITE FALSE TRUE will permanently disables the
write to FUSE_RSA authentication key by programming control bit of FUSE. FALSE
will not modify this control bit of eFuse. define
XSK_EFUSEPL_DISABLE_128BIT_USER_KEY_WRITE FALSE TRUE will permanently disables
the write to 128 bit FUSE_USER by programming control bit of FUSE. FALSE will
not modify this control bit of eFuse define XSK_EFUSEPL_ALLOW_ENCRYPTED_ONLY
FALSE TRUE will permanently allows encrypted bitstream only. FALSE will not
modify this Secure bit of eFuse. define XSK_EFUSEPL_FORCE_USE_FUSE_AES_ONLY
FALSE TRUE then allows only FUSE's AES key as source of encryption FALSE then
allows FPGA to configure an unencrypted bitstream or bitstream encrypted using
key stored BBRAM or eFuse. define XSK_EFUSEPL_ENABLE_RSA_AUTH FALSE TRUE will
enable RSA authentication of bitstream FALSE will not modify this secure bit of
eFuse. define XSK_EFUSEPL_DISABLE_JTAG_CHAIN FALSE TRUE will disable JTAG
permanently. FALSE will not modify this secure bit of eFuse. define
XSK_EFUSEPL_DISABLE_TEST_ACCESS FALSE TRUE will disables Xilinx test access.
FALSE will not modify this secure bit of eFuse. define
XSK_EFUSEPL_DISABLE_AES_DECRYPTOR FALSE TRUE will disables decoder completely.
FALSE will not modify this secure bit of eFuse. define
XSK_EFUSEPL_ENABLE_OBFUSCATION_EFUSEAES FALSE TRUE will enable obfuscation
feature for eFUSE AES key, this instructs the device to decode the eFUSE AES key
to actual AES key before decrypting the bitstream. FALSE will not modify this
secure bit of eFUSE. define XSK_EFUSEPL_AXI_GPIO_DEVICE_ID
XPAR_AXI_GPIO_0_DEVICE_ID Default value is XPAR_AXI_GPIO_0_DEVICE_ID This macro
is for providing exact GPIO device ID, based on the design configuration this
macro should be modified to provide GPIO device ID which is used for connecting
MASTER JTAG pins. In Ultrascale GPIO pins used for connecting MASTER_JTAG pins
and hardware module to access eFUSE. Following are the GPIO pins and user can
change these pins define XSK_EFUSEPL_AXI_GPIO_JTAG_TDO (0) define
XSK_EFUSEPL_AXI_GPIO_HWM_READY (1) define XSK_EFUSEPL_AXI_GPIO_HWM_END (2)
define XSK_EFUSEPL_AXI_GPIO_JTAG_TDI (0) define XSK_EFUSEPL_AXI_GPIO_JTAG_TMS
(1) define XSK_EFUSEPL_AXI_GPIO_JTAG_TCK (2) define
XSK_EFUSEPL_AXI_GPIO_HWM_START (3) define XSK_EFUSEPL_GPIO_INPUT_CH (2) This
macro is for providing channel number of ALL INPUTS connected (Master JTAG's -
TDO, Hardware module's - READY and END) define XSK_EFUSEPL_GPIO_OUTPUT_CH (1)
This macro is for providing channel number of ALL OUTPUTS connected (Master
JTAG's - TDI, TCK, TMS,and Hardware module's - START) NOTE: All inputs and
outputs of GPIO can be configured in single channel also i.e
XSK_EFUSEPL_GPIO_INPUT_CH XSK_EFUSEPL_GPIO_OUTPUT_CH 1 or 2. Among (TDI, TCK,
TMS, START) Outputs of GPIO cannot be connected to different GPIO channels all
the 4 signals should be in same channel. (TDO, READY and END) can be a other
channel of (TDI, TCK, TMS, START) or the same. define
XSK_EFUSEPL_PROGRAM_AES_KEY FALSE TRUE will burn the AES key given in
XSK_EFUSEPL_AES_KEY. FALSE will ignore the values given. define
XSK_EFUSEPL_PROGRAM_USER_KEY FALSE TRUE will burn 32 bit User key given in
XSK_EFUSEPL_USER_KEY FALSE will ignore the values given. define
XSK_EFUSEPL_PROGRAM_RSA_HASH FALSE TRUE will burn RSA hash given in
XSK_EFUSEPL_RSA_KEY_HASH_VALUE FALSE will ignore the values given. define
XSK_EFUSEPL_PROGRAM_USER_KEY_128BIT FALSE TRUE will burn 128 bit User key given
in XSK_EFUSEPL_USER_KEY_128BIT_0, XSK_EFUSEPL_USER_KEY_128BIT_1,
XSK_EFUSEPL_USER_KEY_128BIT_2, XSK_EFUSEPL_USER_KEY_128BIT_3 FALSE will ignore
the values given. define XSK_EFUSEPL_CHECK_AES_KEY FALSE TRUE will perform CRC
check of FUSE_AES with provided CRC value in macro
XSK_EFUSEPL_CRC_OF_EXPECTED_AES_KEY. And result of CRC check will be updated in
XilSKey_EPl instance parameter AESKeyMatched with either TRUE or FALSE. FALSE
CRC check of FUSE_AES will not be performed. define XSK_EFUSEPL_READ_USER_KEY
FALSE TRUE will read 32 bit FUSE_USER from Ultrascale's eFuse and updates in
XilSKey_EPl instance parameter UserKeyReadback FALSE 32 bit FUSE_USER key read
will not be performed. define XSK_EFUSEPL_READ_RSA_HASH FALSE TRUE will read
FUSE_USER from Ultrascale's eFuse and updates in XilSKey_EPl instance parameter
RSAHashReadback FALSE FUSE_RSA_HASH read will not be performed. define
XSK_EFUSEPL_READ_USER_KEY128_BIT FALSE TRUE will read 128 bit USER key from
Ultrascale's eFuse and updates in XilSKey_EPl instance parameter
User128BitReadBack FALSE 128 bit USER key read will not be performed. define
XSK_EFUSEPL_AES_KEY
"0000000000000000000000000000000000000000000000000000000000000000" define
XSK_EFUSEPL_AES_KEY_SLR2
"0000000000000000000000000000000000000000000000000000000000000000" define
XSK_EFUSEPL_AES_KEY_SLR3
"0000000000000000000000000000000000000000000000000000000000000000" define
XSK_EFUSEPL_AES_KEY_SLR4
"0000000000000000000000000000000000000000000000000000000000000000" The value
mentioned in this will be converted to hex buffer and written into the PL eFUSE
array when write API used. This value should be the AES key given in string
format. It should be 64 characters long, valid characters are 0-9,a-f,A-F. Any
other character is considered as invalid string and will not burn AES Key. Note
that, for writing the AES Key, XSK_EFUSEPL_PROGRAM_AES_KEY for particular
SLR(1/2/3/4)should have TRUE value. define XSK_EFUSEPL_USER_KEY "00000000"
define XSK_EFUSEPL_USER_KEY_SLR2 "00000000" define XSK_EFUSEPL_USER_KEY_SLR3
"00000000" define XSK_EFUSEPL_USER_KEY_SLR4 "00000000" The value mentioned in
this will be converted to hex buffer and written into the PL eFUSE array when
write API used. This value should be the User Key given in string format. It
should be 8 characters long, valid characters are 0-9,a-f,A-F. Any other
character is considered as invalid string and will not burn User Key. Note that,
for writing the User Key, XSK_EFUSEPL_PROGRAM_USER_KEY_ULTRA for particular
SLR(1/2/3/4)should have TRUE value. define XSK_EFUSEPL_RSA_KEY_HASH_VALUE
"0000000000000000000000000000000000000000000000 \
00000000000000000000000000000000000000000000000000" define
XSK_EFUSEPL_RSA_KEY_HASH_VALUE_SLR2
"0000000000000000000000000000000000000000000000 \
00000000000000000000000000000000000000000000000000" define
XSK_EFUSEPL_RSA_KEY_HASH_VALUE_SLR3
"0000000000000000000000000000000000000000000000 \
00000000000000000000000000000000000000000000000000" define
XSK_EFUSEPL_RSA_KEY_HASH_VALUE_SLR4
"0000000000000000000000000000000000000000000000 \
00000000000000000000000000000000000000000000000000" The value mentioned in this
will be converted to hex buffer and written into the PL eFUSE array when write
API used. This value should be the RSA Key hash given in string format. It
should be 96 characters long, valid characters are 0-9,a-f,A-F. Any other
character is considered as invalid string and will not burn RSA hash value. Note
that, for writing the RSA hash, XSK_EFUSEPL_PROGRAM_RSA_HASH_ULTRA for
particular SLR(1/2/3/4) should have TRUE value. define
XSK_EFUSEPL_USER_KEY_128BIT_0 "00000000" define XSK_EFUSEPL_USER_KEY_128BIT_1
"00000000" define XSK_EFUSEPL_USER_KEY_128BIT_2 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_3 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_0_SLR2 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_1_SLR2 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_2_SLR2 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_3_SLR2 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_0_SLR3 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_1_SLR3 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_2_SLR3 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_3_SLR3 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_0_SLR4 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_1_SLR4 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_2_SLR4 "00000000" define
XSK_EFUSEPL_USER_KEY_128BIT_3_SLR4 "00000000" The above four macros are meant
for providing 128 bit User key for SLR(1/2/3/4), XSK_EFUSEPL_USER_KEY_128BIT_0
holds 31:0 bits, XSK_EFUSEPL_USER_KEY_128BIT_1 holds 63:32 bits,
XSK_EFUSEPL_USER_KEY_128BIT_2 holds 95:64 bits and XSK_EFUSEPL_USER_KEY_128BIT_3
holds 127:96 bits of whole 128 bit User key. The value mentioned in this will be
converted to hex buffer and written into the PL eFUSE array when write API used.
This value should be the User Key given in string format. It should be 8
characters long, valid characters are 0-9,a-f,A-F. Any other character is
considered as invalid string and will not burn User Key. Note that, for writing
the User Key, XSK_EFUSEPL_PROGRAM_USER_KEY_128BIT should have TRUE value. define
XSK_EFUSEPL_CRC_OF_EXPECTED_AES_KEY XSK_EFUSEPL_AES_CRC_OF_ALL_ZEROS define
XSK_EFUSEPL_CRC_OF_EXPECTED_AES_KEY_SLR2 XSK_EFUSEPL_AES_CRC_OF_ALL_ZEROS define
XSK_EFUSEPL_CRC_OF_EXPECTED_AES_KEY_SLR3 XSK_EFUSEPL_AES_CRC_OF_ALL_ZEROS define
XSK_EFUSEPL_CRC_OF_EXPECTED_AES_KEY_SLR4 XSK_EFUSEPL_AES_CRC_OF_ALL_ZEROS
XSK_EFUSEPL_AES_CRC_OF_ALL_ZEROS is the default value for all SLRs and is
hexadecimal CRC value of FUSE_AES with all Zeros. Please provide CRC of the AES
key programmed. For Checking CRC of FUSE_AES XSK_EFUSEPL_CHECK_AES_KEY_ULTRA
macro should be TRUE otherwise CRC check will not be performed. For calculation
of AES key's CRC one can use u32 XilSKey_CrcCalculation(u8 Key) API NOTE:Please
make sure you have sufficient heap and stack to run this application. For more
information on creating vivado design please refer to xapp1283. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpoolla
04/26/13 First release 1.01a hk 09/18/13 Added BBRAM related definitions 3.00
vns 31/07/15 Added efuse functionality for Ultrascale. In Ultrascale GPIO pins
and channels macros are added to access Master Jtag primitive and also added
extra control bits and secure bits for Ultrascale's eFuse. 4.00 vns 09/10/15
Added DFT JTAG disable and DFT MODE disable programming options for Zynq eFuse
PS. 6.0 vns 07/07/16 Added Gpio pin numbers connected to hardware module.
27/08/16 Modified XSK_EFUSEPL_DISABLE_DECODER macro to
XSK_EFUSEPL_DISABLE_AES_DECRYPTOR 6.1 vns 10/25/16 Removed
XSK_BBRAM_FORCE_PCYCLE_RECONFIG and XSK_BBRAM_DISABLE_JTAG_CHAIN, from Zynq
BBRAM configurations as they are not actually programming any control bit. These
2 are part of the eFUSE PL and they already exist at eFUSE PL configurations
(XSK_EFUSEPL_FORCE_PCYCLE_RECONFIG and XSK_EFUSEPL_DISABLE_JTAG_CHAIN) 6.4 vns
02/27/18 Added support for programming secure bit enable obfuscation feature for
eFUSE AES key 6.7 psl 03/20/19 Added eFuse key write support for SSIT devices.
psl 03/29/19 Added support for user configurable GPIO for jtag control. 6.8 psl
05/28/19 Added Macro for expected CRC of AES key for different SLR. 6.8 psl
06/07/19 Added doxygen tags. </pre>

FILES:
lib/sw_services/xilskey/examples/xilskey_input.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. / @file xilskey_puf_registration.c
This file illustrates how to do PUF registration and generating syndrome data
and obtaining helper data, debug 2 result, Auxiliary and CHash values from
generated syndrome data. This example also encrypts the provided AES key with
PUF and generates the black key. Finally programs the PUF code and black key
into eFUSE on user request (provided in xilskey_puf_registration.h) <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- --- -------- 6.1 rp 17/10/16
First release. 6.2 vns 02/18/17 Modified Encrypt API call due to change in
Xilsecure 03/10/17 Added Support for programming and reading PUF reserved bit
6.7 mmd 03/17/19 Ignored PUF data on overflow </pre> @note / Include Files /

FILES:
lib/sw_services/xilskey/examples/xilskey_puf_registration.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_puf_registration.h This
file contains header interface related information for PUF device and macros
used in the driver @note User configurable parameters for PUF define
XSK_PUF_INFO_ON_UART FALSE TRUE will display syndrome data on the UART com port
FALSE will display any data on UART com port. define XSK_PUF_PROGRAM_EFUSE FALSE
TRUE will program the generated syndrome data, CHash ,Auxiliary values, and the
Black key. FALSE will not program data into eFUSE. define
XSK_PUF_IF_CONTRACT_MANUFACTURER FALSE This should be enabled when application
is hand over to contract manufacturer. TRUE will allow only authenticated
application. FALSE authentication is not mandatory. define XSK_PUF_REG_MODE
XSK_PUF_MODE4K PUF registration is performed in 4K mode. Only 4K mode is
supported and user should not modify this value. define XSK_PUF_READ_SECUREBITS
FALSE TRUE will read the status of the PUF secure bits from eFUSEs and will be
displayed on UART. FALSE will not read the secure bits. define
XSK_PUF_PROGRAM_SECUREBITS FALSE TRUE will program PUF secure bits based on the
user input provided at XSK_PUF_SYN_INVALID, XSK_PUF_SYN_WRLK and
XSK_PUF_REGISTER_DISABLE FALSE will not program any PUF secure bits. define
XSK_PUF_SYN_INVALID FALSE TRUE will permanently invalidates the already
programmed syndrome data. FALSE will not modify anything define XSK_PUF_SYN_WRLK
FALSE TRUE will permanently disable programming syndrome data into eFUSEs. FALSE
will not modify anything. define XSK_PUF_REGISTER_DISABLE FALSE TRUE will
permanently disable PUF syndrome data registration. FALSE will not modify
anything. define XSK_PUF_RESERVED FALSE TRUE programs this reserved eFUSE bit.
FALSE will not modify anything. define XSK_PUF_AES_KEY
"0000000000000000000000000000000000000000000000000000000000000000" The value
will be converted to hex buffer and encrypts this with PUF in order to generate
black key ,the black key will get written to the PS eFUSE array when
XSK_PUF_PROGRAM_EFUSE macro is set to TRUE. This value should be given in string
format. It should be 64 characters long, valid characters are 0-9,a-f,A-F. Any
other character is considered as invalid and will not burn Black key. Note:
Provided here should be red key and application calculates the black key and
programs into eFUSE if XSK_PUF_PROGRAM_EFUSE macro is TRUE. To avoid programming
eFUSE results can be displayed on UART com port by making XSK_PUF_INFO_ON_UART
to TRUE. define XSK_PUF_BLACK_KEY_IV "000000000000000000000000" The value
mentioned here will be converted to hex buffer. This is Initialization
vector(IV) used with the AES-GCM cryptographic hardware in order to generate
encrypted red key, which is black key. This value should be given in string
format. It should be 24 characters long, valid characters are 0-9,a-f,A-F. Any
other character is considered as invalid string. <pre> MODIFICATION HISTORY: Ver
Who Date Changes ----- ---- -------- 6.1 rp 17/10/16 First release. 6.2 vns
03/10/17 Added support for programming and reading one reserved bit 6.3 vns
10/05/18 Corrected the following macro XSK_PUF_IV to XSK_PUF_BLACK_KEY_IV and
XSK_PUF_IF_CONTRACT_MANUFATURER to XSK_PUF_IF_CONTRACT_MANUFACTURER 6.8 psl
06/07/19 Added doxygen tags </pre>

FILES:
lib/sw_services/xilskey/examples/xilskey_puf_registration.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_bbram.c @note .
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a hk 09/18/13
First release 3.00 vns 31/07/15 Removed redundant code to initialise timer. 5.00
vns 09/01/16 Added BBRAM programming functionality for Ultrascale 6.0 vns
07/28/16 Added configuration counting feature and Obfuscated key programming and
calculation of ECC for 28 bits of control word. 6.6 vns 06/06/18 Added doxygen
tags 6.7 psl 03/20/19 Added BBRAM key write support for SSIT devices. arc
04/04/19 Fixed CPP warnings. psl 04/15/19 Moved XilSKey_Bbram_JTAGServerInit
function from examples to library. 6.8 psl 05/21/19 Added check for
SystemInitDone, to initialize jtag server only once to solve stack corruption
issue. Include Files /

FILES:
lib/sw_services/xilskey/src/xilskey_bbram.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_bbramps_zynqmp.c This
file contains the implementation of the interface functions for programming
BBRAM of ZynqMp. <pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ------
-------- 4.0 vns 10/08/15 First release 6.5 vns 03/16/18 Fixed hanging issue
when program/zeroise is requested while programming mode in enabled state. vns
04/20/18 Added Zeroization at starting of the function call If in case
controller is not in programming mode zeroization occurs without latency. 6.6
vns 06/06/18 Added doxygen tags 6.7 arc 01/05/19 Fixed MISRA-C violations. arc
25/02/19 Added asserts for pointer parameter for NULL verification Added
Timeouts and status info for the functions XilSKey_ZynqMp_Bbram_Program
XilSKey_ZynqMp_Bbram_Zeroise 6.7 psl 03/21/19 Fixed MISRA-C violation. </pre>
Include Files /

FILES:
lib/sw_services/xilskey/src/xilskey_bbramps_zynqmp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_bbramps_zynqmp_hw.h
This header file contains identifiers and register-level driver functions (or
macros) that can be used to access the Xilinx ZynqMp BBRAM controller. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 4.0 vns
10/08/15 First release </pre>

FILES:
lib/sw_services/xilskey/src/xilskey_bbramps_zynqmp_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_epl.c @note Contains
the function definitions for the PL eFUSE functionality. MODIFICATION HISTORY:
Ver Who Date Changes ----- ---- -------- 1.00a rpoolla 04/26/13 First release
1.02a hk 10/28/13 Added API's to read status bits and key.PR 735957 2.00 hk
22/01/14 Corrected PL voltage checks to VCCINT and VCCAUX. CR768077 2.1 kvn
04/01/15 Fixed warnings. CR716453. 3.00 vns 31/07/15 Added efuse functionality
for Ultrascale. 4.0 vns 10/01/15 provided conditional compilation to support
ZynqMp platform also. Corrected error code names of Ultrascale efuse PL 5.0 vns
07/01/16 Verificaion of programming bits is done by performing all Margin reads.
Added conditions for programming control and secure bits. 6.00 vns 29/06/16
Added Margin 2 read verification after programming every Zynq's eFUSE PL bit CR
953052. 07/07/16 Modified XilSKey_EfusePl_ProgramBit_Ultra such that it returns
error code when JtagWrite_Ultrascale fails programming eFUSE bit. Error occurs
only when Hardware Module has encountered timeout. 26/07/16 Added 128 bit user
key programming and reading. Provided single bit programming feature for 32 and
128 bit user keys for eFUSE Ultrascale. 6.4 vns 02/27/18 Added support for
programming secure bit 6 enable obfuscation feature for eFUSE AES key 6.6 vns
06/06/18 Added doxygen tags 6.7 psl 03/20/19 Added eFuse key write support for
SSIT devices. arc 04/04/19 Fixed CPP warnings. psl 04/15/19 Added JtagServerInit
function. 6.8 psl 05/21/19 Added else case to clear UserFuses_TobePrgrmd Include
Files /

FILES:
lib/sw_services/xilskey/src/xilskey_epl.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_eps.c This file
contains the PS eFUSE API's to program/read the eFUSE array. @note None.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpoolla
04/26/13 First release 1.02a hk 10/28/13 Added API to read status register.PR
735957 2.00 hk 23/01/14 Changed PS efuse error codes for voltage out of range.
2.1 sk 04/03/15 Initialized RSAKeyReadback with Zeros CR 829723. 3.00 vns
31/07/15 Removed redundant code to initialise timer. 4.00 vns 09/10/15 Added DFT
control bits programming fecility for eFuse PS on Zynq. PR862778 Added
Conditional compilation to support Zynq Mp also. 5.00 vns 27/01/16 Fixed array
out of bounds error CR 931207 6.0 vns 29/06/16 Added Margin 2 read verification
after programming every Zynq's eFUSE PS bit CR 953052. vns 07/17/16 Fixed CR
954260, Modified XilSKey_EfusePs_Write API to program eFUSE protect bit after
programming DFT bits 6.6 vns 06/06/18 Added doxygen tags Include Files /

FILES:
lib/sw_services/xilskey/src/xilskey_eps.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_eps_zynqmp.c This file
contains the PS eFUSE API's of ZynqMp to program/read the eFUSE array. @note
None. </pre> MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 4.0
vns 10/01/15 First release vns 10/20/15 Modified
XilSKey_ZynqMp_EfusePs_ReadSecCtrlBits API when reading from efuse memory to
return both bits of secure control feature for RSA enable, PPK hash bits invalid
bits. 6.0 vns 07/18/16 PR 1968, Provided User FUSEs single bit programming
Removed JTAG User code programming and reading feature. Added temperature and
voltage checks, while programming and reading eFUSE array. Added separate
function to set timing parameters and sysmon PSU driver initialization. Added
init function while from eFUSE. Added appropriate error codes on failure
returns. vns 08/24/16 Fixed eFUSE ZynqMP programming by adding unlocking before
eFUSE PS initialization. 6.2 vns 02/18/17 Added margin reads for verifying,
added CRC check, Removed temperature checks for each bit. Added temperature
checks in all read APIs. 6.4 vns 02/19/18 Added efuse cache reload call in
function XilSKey_ZynqMp_EfusePs_Write(), so on successful efuse programming,
programmed fuses can directly read from cache of the efuse. 6.6 vns 06/06/18
Added doxygen tags vns 09/18/18 Added APIs to support eFUSE programming from
linux vns 10/11/18 Added support to re-program non-zero SPKID 6.7 arc 01/05/19
Fixed MISRA-C violations. arc 25/02/19 Added NULL checks and validations for
input params and add timeouts and status info arc 03/15/19 Modified initial
default status value as XST_FAILURE 6.7 psl 03/21/19 Fixed MISRA-C violation.
6.8 psl 06/07/19 Added doxygen tags psl 06/25/19 Fixed Coverity warnings. psl
06/28/19 Added doxygen tags. psl 07/05/19 Added Asserts for validation. psl
07/12/19 Corrected length of data to read for XilSKey_EfusePs_ConvertBytesBeToLe
function. psl 07/23/19 Fixed input validations. </pre> Include Files /

FILES:
lib/sw_services/xilskey/src/xilskey_eps_zynqmp.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_eps_zynqmp_hw.h This
header file contains identifiers and register-level driver functions (or macros)
that can be used to access the Xilinx ZynqMp eFuse controller. <pre>
MODIFICATION HISTORY: Ver Who Date Changes ----- ------ -------- 4.0 vns
10/01/15 First release 6.0 vns 07/18/16 Modified RSA enable bit mask 6.2 vns
03/10/17 Added support for LBIST, LPD and FPD sc enable, PBR_BOOT_ERROR. 6.7 arc
01/05/19 Fixed MISRA-C violations. </pre>

FILES:
lib/sw_services/xilskey/src/xilskey_eps_zynqmp_hw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_eps_zynqmp_puf.c This
file contains the APIs for registering PUF, eFUSE programming and reading the
PUF helper data, CHASH and Auxiliary data. </pre> MODIFICATION HISTORY: Ver Who
Date Changes ----- ---- -------- 6.1 vns 10/17/16 First release. vns 11/07/16
Fixed shutter value to 0x0100005e, as sysosc selection is fixed for PUF
registration. 6.2 vns 02/18/17 Added masking for PUF auxiliary read. 6.6 vns
06/06/18 Added doxygen tags 6.7 arc 01/05/19 Fixed MISRA-C violations. arc
03/15/19 Modified initial default status value as XST_FAILURE mmd 03/17/19
Handled buffer underflow issue and added timeouts during syndrome data reading
rama 03/25/19 Added polling routine for PUF ready state 6.8 psl 06/07/19 Added
doxygen tags. psl 06/25/19 Fixed Coverity warnings. psl 06/28/19 Added doxygen
tags. psl 07/05/19 Added Asserts for validation. psl 07/23/19 Fixed input
validation. </pre> Include Files /

FILES:
lib/sw_services/xilskey/src/xilskey_eps_zynqmp_puf.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_epshw.h @note None.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpoolla
04/26/13 First release 4.00 vns 09/10/15 Added DFT control bits addresses /

FILES:
lib/sw_services/xilskey/src/xilskey_epshw.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. JTAG server interface This interface
is intended to be a common abstraction of JTAG cable implementations. Interface
usage steps: 1. Initialize server implementation instance using implementation
specific js_init_() function. 2. Enumerate available ports using
js_get_port_descr_list(). 3. Open selected port using js_open_port(). 4.
Optional: get or set properties using js_get_property() or js_set_property(). 5.
Optional: enumerate scan chain using js_detect_taps() or manually. Add nodes for
each TAP controller (API TDB). 6. Build command sequence(s) object using
js_create_command_sequence(), js_add_state_change(), and js_add_shift(). 7. Run
sequence using js_run_command_sequence(). 8. Repeat 6 and 7 as needed, possibly
deleting or clearing command sequence objects as needed using
js_delete_command_sequence() and js_clear_command_sequence(). 9. Close port
using js_close_port(). 10. Delete server using js_deinit_server(). /

FILES:
lib/sw_services/xilskey/src/xilskey_js.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_jscmd.c Contains jtag,
efuse and bbram related API's @note <pre> MODIFICATION HISTORY: Ver Who Date
Changes ----- ---- -------- 1.00a rpoolla 04/26/13 First release 1.01a hk
09/18/13 Added BBRAM functionality. Following API's added: int
JtagServerInitBbram(XilSKey_Bbram InstancePtr) int Bbram_Init(XilSKey_Bbram
InstancePtr) int Bbram_ProgramKey(XilSKey_Bbram InstancePtr) int
Bbram_VerifyKey(XilSKey_Bbram InstancePtr) void Bbram_DeInit(void) 2.1 kvn
04/01/15 Fixed warnings. CR716453. 3.00 vns 31/07/15 Added efuse functionality
for Ultrascale. 4.00 vns 09/10/15 Modified JtagWrite API as per IEEE 1149.1
standard added TCK toggle after RTI state change where programming will start
and toggled TCK again at exit of RTI state to stop programming. CR885421. 5.0
vns 01/07/16 Modified JtagWrite_Ultrascale API as per IEEE 1149.1 standard added
TCK toggle after RTI state change where programming will start and ends
programming at TCK toggle after DR_SELECT state. CR 924262 Modified
JtagServerInitBbram to support Ultrascale BBRAM programming, added
Bbram_Init_Ultra, Bbram_ProgramKey_Ultra, Bbram_VerifyKey_Ultra and
Bbram_DeInit_Ultra APIs 6.0 vns 07/07/16 Initialized hardware module connections
Modified JtagWrite_Ultrascale API, to handover programming sequence to hardware
module to take care of eFUSE programming. Once Hardware module is triggered,
JTAG state will be entering to IDLE state and will wait for 5us and toggles TCK
pin at 1Mhz frequency. Finally it exists when jtag state is navigated to DR
SELECT by making END pin to High state. Modified return type of
JtagWrite_Ultrascale API to int for returning FAILURE on timeout. vns 07/28/16
Modified Bbram_ProgramKey_Ultra API to program control word based on user
inputs. 6.4 vns 02/27/18 Added support for virtex and virtex ultrascale plus 6.7
psl 03/18/19 Modified code to mask most significant nibble which represents
production version for ultrascale plus. 03/20/19 Added eFuse/BBRAM key write
support for SSIT devices. psl 03/29/19 Added Support for user configurable GPIO
for jtag control. arc 04/04/19 Fixed CPP warnings. psl 04/15/19 Corrected zynq
Dap ID. 6.8 psl 06/26/19 Added support for user to add IDCODE, IR_length, SLR
Nos, device series for different devices. </pre>

FILES:
lib/sw_services/xilskey/src/xilskey_jscmd.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. JTAG server implementation library
interface This library interface is intended to be use by JTAG server
implementations only, i.e. not used by JTAG server clients. /

FILES:
lib/sw_services/xilskey/src/xilskey_jslib.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_utils.c @note None.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpoolla
04/26/13 First release 2.00 hk 22/01/14 Corrected PL voltage checks to VCCINT
and VCCAUX. CR768077 2.1 kvn 04/01/15 Fixed warnings. CR716453. 3.00 vns
31/07/15 Added efuse functionality for Ultrascale. 4.0 vns 10/01/15 Modified
conditional compilation to support ZynqMp platform also. Added new API Xsk_Ceil
Modified Xilskey_CrcCalculation() API for providing support for efuse ZynqMp
also. 6.0 vns 07/07/16 Modified XilSKey_Timer_Intialise API to initialize
TimerTicks to 10us. As Hardware module only takes care of programming time(5us),
through software we only need to control hardware module. Modified sysmon read
to 16 bit resolution as sysmon driver has modified conversion formulae to 16 bit
resolution. vns 07/18/16 Initialized sysmonpsu driver and added
XilSKey_ZynqMP_EfusePs_ReadSysmonVol and XilSKey_ZynqMP_EfusePs_ReadSysmonTemp
functions 6.6 vns 06/06/18 Added doxygen tags 6.7 arc 01/05/19 Fixed MISRA-C
violations. vns 02/09/19 Fixed buffer overflow access in
XilSKey_Efuse_ConvertStringToHexLE() arc 25/02/19 Added asserts for pointer
parameter for NULL verification Fixed Length parameter as length in bits for
XilSKey_Efuse_ConvertStringToHexBE and added length validations arc 03/13/19
Added assert to validate lengths in XilSKey_Efuse_ValidateKey() arc 03/15/19
Modified initial default status value as XST_FAILURE 6.7 psl 03/21/19 Fixed
MISRA-C violation. vns 03/23/19 Fixed CRC calculation for Ultra plus arc
04/04/19 Fixed CPP warnings. 6.8 psl 06/07/19 Added doxygen tags. psl 06/25/19
Fixed Coverity warnings. psl 06/28/19 Added doxygen tags. / Include Files /

FILES:
lib/sw_services/xilskey/src/xilskey_utils.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_bbram.h @addtogroup
xilskey_zynq_ultra_bbram BBRAM PL @{ @cond xilskey_internal @{ @note Contains
the function prototypes, defines and macros for BBRAM functionality.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.01a hk 09/18/13
First release 4.0 vns 10/08/15 Added prototypes for ZynqMp BBRAM PS 5.0 vns
01/09/16 Added functionality of Ultrascale BBRAM programming. 6.0 vns 07/28/16
Added IsKeyObfuscated, Enable_DpaProtect, Dpa_Count, Dpa_Mode and CtrlWord
fields to BBRAM instance. 6.1 vns 10/25/16 Removed ForcePowerCycle and
JtagDisable from BBRAM Zynq instance, as they are not actually programming any
bit They already exists in Zynq eFUSE PL instances 6.6 vns 06/06/18 Added
doxygen tags 6.7 arc 25/02/19 Changed void XilSKey_ZynqMp_Bbram_Zeroise(void)
prototype to u32 XilSKey_ZynqMp_Bbram_Zeroise(void) psl 03/20/19 Added BBRAM key
write support for SSIT devices. psl 03/29/19 Added Support for user configurable
GPIO for jtag control. 6.8 psl 05/21/19 Added SystemInitDone to check jtag
initialized or not.

FILES:
lib/sw_services/xilskey/src/include/xilskey_bbram.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_epl.h @addtogroup
xilskey_zynq_ultra_efuse EFUSE PL @{ @cond xilskey_internal @{ @note Contains
the function prototypes, defines and macros for the PL eFUSE functionality.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpoolla
04/26/13 First release 1.02a hk 10/28/13 Added API's to read status bits and key
: u32 XilSKey_EfusePl_ReadKey(XilSKey_EPl InstancePtr) u32
XilSKey_EfusePl_ReadKey(XilSKey_EPl InstancePtr) 2.00 hk 22/01/14 Corrected PL
voltage checks to VCCINT and VCCAUX. CR768077 3.00 vns 31/07/15 Added efuse
functionality for Ultrascale. 6.0 vns 07/07/16 Added Hardware module pins in
eFUSE PL instance. 6.4 vns 02/27/18 Added support for programming secure bit 6
enable obfuscation feature for eFUSE AES key vns 03/09/18 Added correct status
bit positions to Ultrascale plus 6.6 vns 06/06/18 Added doxygen tags 6.7 arc
01/05/19 Fixed MISRA-C violations. psl 03/20/19 Added eFuse key write support
for SSIT devices. psl 03/29/19 Added Support for user configurable GPIO for jtag
control

FILES:
lib/sw_services/xilskey/src/include/xilskey_epl.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_eps.h @addtogroup
xilskey_zynq_efuse Zynq EFUSE PS @{ @cond xilskey_internal @{ @note None.
MODIFICATION HISTORY: Ver Who Date Changes ----- ---- -------- 1.00a rpoolla
04/26/13 First release 1.02a hk 10/28/13 Added API to read status register: u32
XilSKey_EfusePs_ReadStatus( XilSKey_EPs InstancePtr, u32 StatusBits) RSA key
read back is stored in RsaKeyReadback in Instance structure instead of
RsaKeyHashValue Change in API: u32 XilSKey_EfusePs_Read(XilSKey_EPs
PsInstancePtr) 2.00 hk 23/01/14 Changed PS efuse error codes for voltage out of
range 2.1 sk 04/03/15 Initialized RSAKeyReadback with Zeros CR 829723. 4.0 vns
10/20/15 Added cplusplus boundary blocks. 6.6 vns 06/06/18 Added doxygen tags
6.7 arc 01/05/19 Fixed MISRA-C changes.

FILES:
lib/sw_services/xilskey/src/include/xilskey_eps.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_eps_zynqmp.h
@addtogroup xilskey_zynqmp_efuse ZynqMP EFUSE PS @{ @cond xilskey_internal @{
Contains the function prototypes, defines and macros for ZynqMP efusePs
functionality. @note None. </pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 4.0 vns 10/01/15 First release vns 10/20/15 Modified secure
control bits readback bits. 6.0 vns 07/18/16 Added separate User FUSEs
programming feasibility Modified XilSKey_ZynqMp_EfusePs_ReadUserFuse prototype.
Removed JTAG user code programming feature.Added
XSK_ZYNQMP_SEC_PPK_INVLD_BITS_SET to check both PPK invalid bits are set or not,
To check RSA authentication enable, defined XSK_ZYNQMP_SEC_RSA_15BITS_SET and
XSK_ZYNQMP_SEC_RSA_2BITS_SET macros. Added all RSA enable bits to enum. Modified
RSAenable variable type to u16. 6.2 vns 03/10/17 Added support for LBIST, LPD
and FPD sc enable, PBR_BOOT_ERROR. Modified names of secure control bits
UseAESOnly -> EncOnly, PMUError->ErrorDisable, PPK0Revoke->PPK0InVld and
PPK1Revoke->PPK1InVld 6.6 vns 06/06/18 Added doxygen tags vns 09/18/18 Added
APIs to support eFUSE programming from linux 6.7 arc 01/05/19 Fixed MISRA-C
violations. </pre>

FILES:
lib/sw_services/xilskey/src/include/xilskey_eps_zynqmp.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_eps_zynqmp_puf.h
@addtogroup xilskey_zynqmp_efuse ZynqMP EFUSE PS @{ @cond xilskey_internal @{
Contains the function prototypes, defines and macros for ZynqMP efusePs puf
functionality. @note None. </pre> MODIFICATION HISTORY: Ver Who Date Changes
----- ---- -------- 6.1 vns 17/10/16 First release. 6.6 vns 06/06/18 Added
doxygen tags 6.7 arc 01/05/19 Fixed MISRA-C violations. mmd 03/17/19 Added PUF
syndrome data length in bytes for 4K mode </pre>

FILES:
lib/sw_services/xilskey/src/include/xilskey_eps_zynqmp_puf.h
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file xilskey_utils.h @cond
xilskey_internal @{ @note None. MODIFICATION HISTORY: Ver Who Date Changes -----
---- -------- 1.00a rpoolla 04/26/13 First release 2.00 hk 23/01/14 Corrected PL
voltage checks to VCCINT and VCCAUX. CR768077. Changed PS efuse error codes for
voltage out of range 3.00 vns 31/07/15 Added Xilskey_Timer_Intialise API and
modified prototype of XilSKey_Efuse_StartTimer Modified efuse PS macro
XSK_EFUSEPS_RSA_KEY_HASH_STRING_SIZE to XSK_EFUSEPL_RSA_KEY_HASH_STRING_SIZE
Added efuse functionality for Ultrascale. 4.0 vns 10/01/15 Added efuse
functionality for ZynqMp platform. Added XilSKey_Ceil API. Added error code for
efuse and bbram PS for Zynq MP. Modified Xilskey_CrcCalculation API name to
XilSKey_CrcCalculation. and Xilskey_Timer_Intialise API to
XilSKey_Timer_Intialise vns 10/20/15 Added cplusplus boundary blocks. 6.0 vns
07/07/16 Added hardware module time out error code 07/18/16 Added error codes
for eFUSE PS User FUSEs programming Added sysmonpsu driver for temperature and
voltage checks. 6.2 vns 03/10/17 Added error codes for LBist, LPD/FPD SC enable
bits programming. 6.4 vns 02/27/18 Added support for virtex and virtex
ultrascale plus 6.6 vns 06/06/18 Added doxygen tags vns 09/18/18 Added error
code for zynqmp efuseps vns 10/11/18 Added new error code for SPKID bit revert
request XSK_EFUSEPS_ERROR_SPKID_BIT_CANT_REVERT 6.7 arc 01/05/19 Fixed MISRA-C
violations. arc 25/02/19 Added Timeout Macro and new error code for bbram
zeroisation and error in write CRC XSK_ZYNQMP_BBRAMPS_ERROR_IN_ZEROISE
XSK_ZYNQMP_BBRAMPS_ERROR_IN_WRITE_CRC mmd 03/17/19 Added timeout and PUF
underflow error psl 03/19/19 FIxed MISRA-C violation psl 03/29/19 Removed GPIO
ID macro. 6.8 psl 06/07/19 Added doxygen tags /

FILES:
lib/sw_services/xilskey/src/include/xilskey_utils.h
--------------------------------------------------------------------------------



POSSIBLE NOTICE(S):

COPYRIGHT TEXT:
---------------

Makefile for Xilinx MCAP Interface Library (c) 2014-2015 Xilinx Inc.

FILES:
mcap/linux/Makefile
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mcap.c MCAP
Interface Library Test Application

FILES:
mcap/linux/mcap.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mcap_lib.c MCAP
Interface Library functions

FILES:
mcap/linux/mcap_lib.c
--------------------------------------------------------------------------------




COPYRIGHT TEXT:
---------------

All rights reserved. Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions: The
above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @file mcap_lib.h MCAP
Interface Library support header file

FILES:
mcap/linux/mcap_lib.h
--------------------------------------------------------------------------------


